Update README
Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja> git-svn-id: file:///srv/svn/repo/suwako/trunk@25 0b558ee1-521d-8b46-a41b-40029c97c055
This commit is contained in:
59
README.md
59
README.md
@@ -1,11 +1,52 @@
|
||||
# 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
|
||||
|
||||
Reference in New Issue
Block a user