From 2afe24592352021c3937930298b1540e091cb57f Mon Sep 17 00:00:00 2001 From: Tobias Zimmermann Date: Fri, 6 Oct 2023 16:11:46 +0200 Subject: [PATCH] change readme a bit --- README.md | 16 +++++++++++++--- package.json | 3 +-- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e205699..742926b 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,17 @@ Keep in mind that Angular's internationalization and localization features, incl ## Installation ```shell -yarn add deepl-localize +npm install deepl-localize -D +``` +or +```shell +yarn add deepl-localize -D +``` + +Of course you can use it with `npx` as well. + +```shell +npx deepl-localize translate -b your/path/en-US.json -l de-DE fr-FR -i de-DE -a "YOUR-DEEPL-API-KEY" ``` ## Translation @@ -52,7 +62,7 @@ deepl-localize translate -b your/path/en-US.json -l de-DE fr-FR -i de-DE -a "YOU | -v, --version | output the version number | | -b, --base | The base file path. | | -o, --output | The output folder path. If none is given, the base folder is used. | -| -l, --locales [value...] | Locales to translate to. For example de-DE,fr-FR. If none is given, no translation will happen. (default: []) | +| -l, --locales [value...] | Locales to translate to. For example de-DE fr-FR. If none is given, no translation will happen. (default: []) | | -i, --informal-locales [value...] | Locales to translate less formal. For example de-DE will use du instead of sie. (default: []) | | -h, --help | display help for command | @@ -72,6 +82,6 @@ deepl-localize remove-stale -b your/path/en-US.json -l de-DE fr-FR | -v, --version | output the version number | | -b, --base | The base file path. | | -o, --output | The output folder path. If none is given, the base folder is used. | -| -l, --locales [value...] | Locales to translate to. For example de-DE,fr-FR. If none is given, no translation will happen. (default: []) | +| -l, --locales [value...] | Locales to translate to. For example de-DE fr-FR. If none is given, no translation will happen. (default: []) | | -d,--dry-run | Just show the stale translations. The script will not remove and just show them. (default: false) | | -h, --help | display help for command | \ No newline at end of file diff --git a/package.json b/package.json index db84a9d..6b17a20 100644 --- a/package.json +++ b/package.json @@ -30,6 +30,5 @@ }, "bin": { "deepl-localize": "./dist/index.js" - }, - "version": "1.0.0" + } }