README.md in crowdin-cli-0.1.0 vs README.md in crowdin-cli-0.1.1
- old
+ new
@@ -81,11 +81,11 @@
Also you can add and upload all directories mathing the pattern including all nested files and localizable files.
Example configuration provided above has 'source' and 'translation' attributes containing standard wildcards (also known as globbing patterns) to make it easier to work with multiple files.
-Here's patterns you can use:
+Here's patterns you can use:
* `*` (asterisk)
This wildcard represents any character in file or directory name. If you specified a `*.json` it will include all files like `messages.json`, `about_us.json` and anything that ends with `.json`.
@@ -132,11 +132,11 @@
ru: ros
uk: ukr
```
Mapping format is the following: `crowdin_language_code : code_use_use`.
-Check [complete list of Crowdin language codes](http://crowdin.net/page/api/language-codes) that can be used for mapping.
+Check [complete list of Crowdin language codes](http://crowdin.net/page/api/language-codes) that can be used for mapping.
You can also override language codes for other placeholders like `%android_code%`, `%locale%` etc...
## Example Configurations
@@ -167,22 +167,41 @@
api_key: KeepTheAPIkeySecret
base_url: http://api.crowdin.net
base_path: /path/to/your/project
files:
- -
+ -
source: '/res/values/*.xml'
translation: '/res/values-%android_code%/%original_file_name%'
languages_mapping:
android_code:
# we need this mapping since Crowdin expects directories
# to be named like "values-uk-rUA"
# acording to specification instead of just "uk"
- de: de
+ de: de
ru: ru
```
+### Uploading CSV files via API
+
+```
+---
+project_identifier: test
+api_key: KeepTheAPIkeySecret
+base_url: http://api.crowdin.net
+base_path: /path/to/your/project
+
+files:
+ -
+ source: '/*.csv'
+ translation: '%two_letters_code%/%original_file_name%'
+ # Defines whether first line should be imported or it contains columns headers
+ first_line_contains_header: true
+ # Used only when uploading CSV file to define data columns mapping.
+ scheme: "identifier,source_phrase,translation,context,max_length"
+```
+
## Usage
When the configuration file is created you are ready to start using `crowdin-cli` to manage your localization resources and automate files synchronization.
We listed most typical commands that crowdin-cli is used for:
@@ -232,8 +251,8 @@
## License and Author
Author: Anton Maminov (anton.maminov@gmail.com)
-Copyright: 2012 [Crowdin.net](http://crowdin.net/)
+Copyright: 2012-2013 [Crowdin.net](http://crowdin.net/)
-This library is distributed under the MIT license. Please see the LICENSE file.
\ No newline at end of file
+This library is distributed under the MIT license. Please see the LICENSE file.