readme.md in web_translate_it-2.1.3 vs readme.md in web_translate_it-2.1.4

- old
+ new

@@ -1,60 +1,62 @@ -# WebTranslateIt Synchronization Tool +# WebTranslateIt Synchronization Tool : wti [RubyDoc](http://rubydoc.info/github/AtelierConvivialite/webtranslateit/) | -[Example app](http://github.com/AtelierConvivialite/rails_example_app) | [Report a bug](http://github.com/AtelierConvivialite/webtranslateit/issues) | [Support](https://webtranslateit.com/support) | [WebTranslateIt.com Homepage](https://webtranslateit.com) -`web_translate_it` is a tool to sync your language files with [WebTranslateIt.com](https://webtranslateit.com), a web-based tool to translation software. +wti lets you easily sync your language files with [WebTranslateIt.com](https://webtranslateit.com), a web-based tool to translation software. ![WebTranslateIt Synchronization Tool](http://f.cl.ly/items/2X3m0h0g0I1O1U07163o/wti_example.jpg) -## This rubygem provides: +### wti... -1. A Command-Line Interface, `wti`, to sync files between your computer/server and WebTranslateIt.com. It is cross-platform and runs in a terminal (Linux, MacOS X) or in cmd.exe (Windows). -2. A synchronisation server which provides a web interface for your translation team to update your language files. [Learn more on the web_translate_it_server project page](https://github.com/AtelierConvivialite/web_translate_it_server). -3. A rack middleware you can use in your Rails app to automatically fetch new translations from WebTranslateIt. +* wti is a **command-line tool**. It works on all operating systems: Windows, Linux, MacOS X... +* wti is really easy to use. It was inspired by git. Use `wti push` and `wti pull` to sync your language files with WebTranslateIt.com. -An external library, [web_translate_it_server](https://github.com/AtelierConvivialite/web_translate_it_server), extends this rubygem and provides a web interface for your translation team to update your language files. +### Optionally, wti does... +* include a rack middleware you can use in your Rails app to automatically fetch new translations from WebTranslateIt.com. +* include libraries you can use to programmatically fetch your segments from WebTranslateIt.com. See [Extras](https://github.com/AtelierConvivialite/webtranslateit/wiki/Extras) +* include a web interface for your translation team to update your language files. [Learn more on the web_translate_it_server project page](https://github.com/AtelierConvivialite/web_translate_it_server). + --- ## Installation You will also need ruby to run `wti`. On Linux or a Mac, it’s already installed. Install [RubyInstaller](http://rubyinstaller.org/) if you’re using Windows. [See detailed installation instructions for Windows users](https://github.com/AtelierConvivialite/webtranslateit/wiki/Install-wti-on-Windows). ``` bash $ gem install web_translate_it -Fetching: web_translate_it-2.0.3.gem (100%) -Successfully installed web_translate_it-2.0.3 +Fetching: web_translate_it-2.1.3.gem (100%) +Successfully installed web_translate_it-2.1.3 1 gem installed ``` At this point you should have the `wti` executable working: ``` bash $ wti -v -wti version 2.0.3 +wti version 2.1.3 ``` ## Configuration Now that the tool is installed, you’ll have to configure your project. Basically, `wti` is to be run on a project root directory, and looks for a `.wti` file containing your project information. The command `wti init` lets your create your `.wti` file. ``` bash -$ wti init +$ wti init 55555abc1235555 # Initializing project - Project API Key: 55555abc1235555 - Path to configuration file: (Default: .wti) Your project was successfully initialized. You can now use `wti` to push and pull your language files. Check `wti --help` for help. ``` -The command asks you to enter your project API key (you can find it in your project settings) and where to save the configuration file (by default it will create a `.wti` in your project root directory). +`55555abc1235555` is the API token, which you can find in your project settings. + +If you’d like to specify another path for your configuration file, you can use `wti init`. This command will ask you to enter your project API token and where to save the configuration file (by default it will create a `.wti` in your project root directory). Now you’re all set and you can use the `wti` commands on your project. ## Usage