Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Readme. resolve #1 #5

Merged
merged 1 commit into from
Jun 4, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# ✍️Deepl translate cli

## Installation

1. Download zipped file from [Releases](https://github.com/Omochice/deepl-translate-cli/releases).

2. Unzip downloaded file.

3. Move executable file into directory in PATH. (like `$HOME/.local/bin/`)


## Before using

1. Get deepl access token. See [here](https://www.deepl.com/docs-api).

2. Set access token as `DEEPL_TOKEN`
ex. in `Bash`.
```bash
export DEEPL_TOKEN <YOUR TOKEN>
```

3. Make configure file in `<user home directory>/.config/deepl-translation/setting.json`.

If run command without existing setting file, auto make it.

For write setting file, see [this page](https://www.deepl.com/docs-api/translating-text/request/).

## Usage

- If you want translate from existing file.
```console
$ deepl-translate <text.txt>
```

- If you want use stdin.
- with pipe
```console
$ echo "hello" | deepl-translation --stdin
```
- with input
```console
$ deepl-translation --stdin
<input text that wanted translate> <Enter>
```