readme.md in web_translate_it-1.8.0.1 vs readme.md in web_translate_it-1.8.1.0
- old
+ new
@@ -5,13 +5,13 @@
[RDoc](http://yardoc.org/docs/AtelierConvivialite-webtranslateit) |
[Example app](http://github.com/AtelierConvivialite/rails_example_app) |
[Report a bug](http://github.com/AtelierConvivialite/webtranslateit/issues) |
[Support](http://help.webtranslateit.com)
-`web_translate_it` is a rubygem providing tools to sync your language files with [Web Translate It](https://webtranslateit.com), a web-based computer-aided translation tool.
+`web_translate_it` is a rubygem providing tools to sync your language files with [Web Translate It](https://webtranslateit.com), a web-based translation software.
-
+
This gem provides:
* a command-line executable `wti`, to sync your files between your computer/server and WebTranslateIt.com,
* a synchronisation server to help your translation team update your language files from a web interface,
@@ -33,45 +33,44 @@
wti init
The tool will prompt for:
-* your Web Translate It API key (you can find it in your project settings),
+* your Web Translate It API key. You can find it in your project settings ([where are the project settings?](http://help.webtranslateit.com/kb/troubleshooting/where-are-my-project-settings)),
* where to save the configuration file (by default in `config/translations.yml`).
Usage
-----
Execute `wti --help` to see the usage:
- wti is a command line tool to sync your local translation files
- with the WebTranslateIt.com service.
+ Usage: wti <command> [options]+
+
+ The most commonly used wti commands are:
+
+ pull Pull target language file(s)
+ push Push master language file(s)
+ match Display matching of local files with File Manager
+ add Create and push a new master language file
+ addlocale Add a new locale to the project
+ server Start a synchronisation server
+ status Fetch and display project statistics
+ init Configure your project to sync
- Usage:
- wti <command> [options]+
+ See `wti <command> --help` for more information on a specific command.
- <command> is one of: pull push add addlocale server stats status st autoconf init
[options] are:
- --config, -c <s>: Path to a translation.yml file (default:
- config/translation.yml)
- --version, -v: Print version and exit
- --help, -h: Show this message
+ --config, -c <s>: Path to a translation.yml file (default:
+ config/translation.yml)
+ --version, -v: Print version and exit
+ --help, -h: Show this message
-Here’s more explanation about the commands.
+Append `--help` for each command for more information. For instance:
- pull Pull target language file(s)
- push Push master language file(s)
- add Create and push a new master language file
- addlocale Add a new locale to the project
- server Start a synchronisation server
- status Fetch and display project statistics
- init Configure your project to sync
-
-You can get more information by appending `--help` after each command. For instance:
-
$ wti push --help
- Options:
- --locale, -l <s>: ISO code of a locale to push
+ Push master language file(s)
+ [options] are:
+ --locale, -l <s>: ISO code of locale(s) to push
--all, -a: Upload all files
--low-priority, -o: WTI will process this file with a low priority
--merge, -m: Force WTI to merge this file
--ignore-missing, -i: Force WTI to not obsolete missing strings
--label, -b <s>: Apply a label to the changes