Changeset 25 in code for trunk/README.md

Timestamp:

Oct 22, 2023, 2:13:40 AM (20 months ago)

Author:

yakumo.izuru

Message:

Update README

Signed-off-by: Izuru Yakumo <yakumo.izuru@…>

File:

• trunk/README.md (modified) (1 diff)

trunk/README.md

@@ -1 @@
-# suwako
-Command-line client for privacy-friendly translation frontends.
+SUWAKO(1) - FreeBSD General Commands Manual
 
-## Usage
--f [lang] (default: auto)
--i [input]
--t [lang] (default: en)
+# NAME
 
-## Environment variables
-* SUWAKO\_ENGINE
-* SUWAKO\_INSTANCE
+**suwako** - Command-line client for SimplyTranslate
+
+# SYNOPSIS
+
+**suwako**
+**-f** *from*
+**-t** *to*
+*input*
+
+# DESCRIPTION
+
+Self-explanatory, besides, this was made as
+a rewrite from a shell script that had curl
+and awk for dependencies.
+It fully serves
+as a drop-in replacement.
+
+# CONFIGURATION
+
+**suwako**
+takes two variables, those being
+`SUWAKO_INSTANCE`
+and
+`SUWAKO_ENGINE`
+
+Both must be filled and placed
+on ~/.suwako/suwako.conf
+
+# USAGE
+
+**-f**
+
+> Input language to translate from.
+> Default is 'auto'
+
+**-t**
+
+> Target language to translate to
+
+<input>
+
+> Text to be translated
+
+# AUTHORS
+
+Izuru Yakumo <[yakumo.izuru@chaotic.ninja](mailto:yakumo.izuru@chaotic.ninja)>
+
+FreeBSD 13.2-RELEASE-p1 - October 21, 2023