README.md in crowdin-cli-0.3.2 vs README.md in crowdin-cli-0.3.3
- old
+ new
@@ -3,17 +3,17 @@
[Crowdin Integration Utility Homepage](http://crowdin.net/page/cli-tool) |
[Support](http://crowdin.net/contacts) |
[Crowdin.net Homepage](http://crowdin.net) |
[crowdin-api RubyDoc](http://rubydoc.info/github/crowdin/crowdin-api/)
-A Command-Line Interface to sync files between your computer/server and [Crowdin](crowdin.net).
+A Command-Line Interface to sync files between local computer/server and [Crowdin](crowdin.net).
-It is cross-platform and runs in a terminal (Linux, MacOS X) or in cmd.exe (Windows).
+It is cross-platform and can be run in a terminal (Linux, MacOS X) or in cmd.exe (Windows).
-> **WARNING**: This is a development version: It contains the latest changes, but may also have severe known issues, including crashes and data loss situations. In fact, it may not work at all.
+> **WARNING**: This is a development version: It contains the latest changes, but may also have several known issues, including crashes and data loss situations. In fact, it may not work at all.
## Installation
Add this line to your application's Gemfile:
@@ -24,20 +24,20 @@
And then execute:
```
$ bundle
```
-Or install it yourself as:
+Or install it manually as:
```
$ gem install crowdin-cli
```
## Configuration
-Now that the tool in installed, you'll have to configure your project. Basically, `crowdin-cli` is to be run on a project directory, and looks for a `crowdin.yaml` file containing your project information.
+When the tool is installed, you would have to configure your project. Basically, `crowdin-cli` go through project directory, and looks for `crowdin.yaml` file that contains project information.
-Create a `crowdin.yaml` YAML file in your root project directory with the following structure:
+Create `crowdin.yaml` YAML file in your root project directory with the following structure:
```
---
project_idenfier: test
api_key: KeepTheAPIkeySecret
@@ -51,14 +51,14 @@
```
* `api_key` - Crowdin Project API key
* `project_identifier` - Crowdin project name
* `base_url` - (default: http://api.crowdin.net)
-* `base_path` - defines what directory we have to scan(default: current directory)
+* `base_path` - defines what directory have to be scaned(default: current directory)
* `files`
- * `source` - defines only files we will upload as sources
- * `translation` - attribute defines where translations should be placed after downloading (also we have to check those path to detect and upload existing translations)
+ * `source` - defines only files that should be uploaded as sources
+ * `translation` - defines where translations should be placed after downloading (also the path have to be checked to detect and upload existing translations)
Use the following placeholders to put appropriate variables into the resulting file name:
* `%language%` - Language name (i.e. Ukrainian)
* `%two_letters_code%` - Language code ISO 639-1 (i.e. uk)
* `%three_letters_code%` - Language code ISO 639-2/T (i.e. ukr)
@@ -77,23 +77,23 @@
Example for Gettext projects:
```
/locale/%two_letters_code%/LC_MESSAGES/%original_file_name%
```
-Also you can add and upload all directories mathing the pattern including all nested files and localizable files.
+Also you can add and upload all directories matching 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.
+Configuration example 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:
* `*` (asterisk)
Match zero or more characters in file name. A glob consisting of only the asterisk and no other characters will match all files in the directory. If you specified a `*.json` it will include all files like `messages.json`, `about_us.json` and anything that ends with `.json`.c* will match all files beginning with c; `*c` will match all files ending with c; and `*c*` will match all files that have c in them (including at the beginning or end). Equivalent to `/ .* /x` in regexp.
* `**` (doubled asterisk)
- Match all directories recursively. Note that you can use `**` in `source` and in `translation` pattern. When using `**` in `translation` pattern it will always contain sub-path from `source` for certain file. The mask `**` can be used only once in the pattern and must be surrounded by backslashes `/`.
+ Match all the directories recursively. Note that you can use `**` in `source` and in `translation` pattern. When using `**` in `translation` pattern it will always contain sub-path from `source` for certain file. The mask `**` can be used only once in the pattern and must be surrounded by backslashes `/`.
* `?` (question mark)
Matches any one character.
@@ -169,11 +169,11 @@
### Preserving directories hierarchy
By default CLI tool tries to optimize your Crowdin project hierarchy and do not repeats complete path of local files online. In case you need to keep directories structure same at Crowdin and locally you can add `preserve_hierarchy: true` option in main section of the configuration file.
-Sample configuration below:
+Configuration sample is below:
```
---
project_identifier: test
api_key: KeepTheAPIkeySecret
@@ -201,11 +201,11 @@
scheme: "identifier,source_phrase,translation,context,max_length"
```
#### Multicolumn CSV
-In case when CSV file should contains translations to all target languages you can use per-file option `multilingual_spreadsheet`.
+In case CSV file contains translations to all target languages you can use per-file option `multilingual_spreadsheet`.
CSV file example:
```
identifier,source_phrase,context,Ukrainian,Russian,French
ident1,Source 1,Context 1,,,
@@ -224,11 +224,11 @@
multilingual_spreadsheet: true
```
-## Example Configurations
+## Configurations Examples
### GetText Project
```
---
@@ -269,10 +269,10 @@
ru: ru
```
## Usage
-When the configuration file is created you are ready to start using `crowdin-cli` to manage your localization resources and automate files synchronization.
+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:
Upload your source files to Crowdin:
```