From 6eff6c8ef7a7b778eed6779a55e908a22c607904 Mon Sep 17 00:00:00 2001 From: Leo Bernard Date: Thu, 7 Mar 2019 23:42:54 +0100 Subject: [PATCH] :memo: Update README --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b3d1432..6d9c0d6 100644 --- a/README.md +++ b/README.md @@ -68,8 +68,11 @@ other files will be ignored. There are two ways that json-autotranslate can interpret files: -- Natural Language -- Key-Based +- Natural Language (`natural`) +- Key-Based (`key-based`) + +If you don't specify a file structure type, json-autotranslate will automatically +determine the type on a per-file basis. In most cases, this is sufficient. ### Natural Language @@ -155,15 +158,15 @@ source strings manually in the console. ``` Options: - -i, --input the directory containing language directories (default: ".") - -l, --source-language specify the source language (default: "en") - -s, --service selects the service to be used for translation (default: "google-translate") - --list-services outputs a list of available services - -c, --config supply a config parameter (e.g. path to key file) to the translation service - -k, --key-based uses the template file's values instead of the keys as translation source - -f, --fix-inconsistencies automatically fixes inconsistent key-value pairs by setting the value to the key - -d, --delete-unused-strings deletes strings in translation files that don't exist in the template - -h, --help output usage information + -i, --input the directory containing language directories (default: ".") + -l, --source-language specify the source language (default: "en") + -t, --type specify the file structure type (default: "auto") + -s, --service selects the service to be used for translation (default: "google-translate") + --list-services outputs a list of available services + -c, --config supply a config parameter (e.g. path to key file) to the translation service + -f, --fix-inconsistencies automatically fixes inconsistent key-value pairs by setting the value to the key + -d, --delete-unused-strings deletes strings in translation files that don't exist in the template + -h, --help output usage information ``` ## Contributing