diff --git a/README.md b/README.md index f15464a..8c6dfa2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ # deepl-cli +**deepl-cli** is a command-line utility that uses the **DeepL** API - https://www.deepl.com - a privacy-friendly translation service. + +The script is written in **bash** and can run on all UNIX-based systems. + +**You need an API key**. You can get it for free from https://www.deepl.com/pro-api. +## Usage +``` +./deepl-cli [-h] [-l] target language [-t] text +``` +For example: +``` +./deepl-cli -l es -t "Hello World" +``` +or +``` +echo "Hello World" | ./deepl-cli -l es +> Hola Mundo + +``` -deepl-cli is a command-line utility that uses the DeepL API - https://www.deepl.com - a privacy-friendly translation service.