From 151f1ee508e0bd7f066c3fd74732c89f4665ff8e Mon Sep 17 00:00:00 2001
From: mace <safemind@posteo.net>
Date: Fri, 29 Sep 2023 11:03:16 +0200
Subject: [PATCH] added README.md

---
 Cargo.lock |  2 +-
 README.md  | 14 ++++++++++++++
 cli.yml    |  4 ++--
 3 files changed, 17 insertions(+), 3 deletions(-)
 create mode 100644 README.md

diff --git a/Cargo.lock b/Cargo.lock
index d228d2b..a7f8265 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -86,7 +86,7 @@ checksum = "ea221b5284a47e40033bf9b66f35f984ec0ea2931eb03505246cd27a963f981b"
 
 [[package]]
 name = "deepl"
-version = "0.1.0"
+version = "1.0.1"
 dependencies = [
  "clap",
  "directories",
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0d731dc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+Cli API for deepl translations. API-Key is required.
+
+USAGE:
+    deepl [OPTIONS] <INPUT>
+
+FLAGS:
+    -h, --help       Prints help information
+    -V, --version    Prints version information
+
+OPTIONS:
+    -s, --source <source_lang>    The language you want to translate. Default is autodectect.
+    -t, --target <target_lang>    The language your text should be tranlated to. Default is DE.
+ARGS:
+    <INPUT>    Text to translate
diff --git a/cli.yml b/cli.yml
index bd1cb8e..32d994d 100644
--- a/cli.yml
+++ b/cli.yml
@@ -7,14 +7,14 @@ args:
         short: s
         long: source
         value_name: source_lang
-        help: The language you want to translate. Default is DE
+        help: The language you want to translate. Default is autodetect.
         takes_value: true
         required: false
     - target:
         short: t
         long: target
         value_name: target_lang
-        help: The language your text should be tranlated to. Default is EN-US
+        help: The language your text should be tranlated to. Default is DE.
         takes_value: true
         required: false
     - INPUT: