README.md in i18n-tasks-0.3.3 vs README.md in i18n-tasks-0.3.4
- old
+ new
@@ -1,14 +1,13 @@
-# i18n-tasks [](https://travis-ci.org/glebm/i18n-tasks) [](https://coveralls.io/r/glebm/i18n-tasks?branch=master) [](https://codeclimate.com/github/glebm/i18n-tasks) [](https://flattr.com/submit/auto?user_id=glebm&url=https%3A%2F%2Fgithub.com%2Fglebm%2Fi18n-tasks)
+# i18n-tasks [![Build Status][badge-travis]][travis] [![Coverage Status][badge-coveralls]][coveralls] [![Code Climate][badge-code-climate]][code-climate] [![Flattr this][badge-flattr]][flattr]
-The default model of i18n key management in frameworks such as Rails is broken.
-
+The basic approach to i18n key management in frameworks such as Rails is far from perfect.
If you use a key that does not exist, this will only blow up at runtime. Keys left over from removed code accumulate
-in the resource files, introducing unnecessary overhead on the translators.
-Translation files can quickly turn to disarray.
+in the resource files, introducing unnecessary overhead on the translators. Translation files can quickly turn to disarray.
-i18n-tasks improves this by using static analysis.
+i18n-tasks improves this by using static analysis. It provides tasks to find and manage missing and unused translations.
+This information is inferred based on the keys the gem detects used with calls such as `I18n.t` when scanning the code.
<img width="534" height="288" src="https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-tasks.png">
## Installation
@@ -21,11 +20,11 @@
2. Create a config file at `config/i18n-tasks.yml`:
```yaml
# config/i18n-tasks.yml
base_locale: en
- locales: [es, fr]
+ locales: [es, fr] # This includes base_locale by default
```
## Usage
Run `i18n-tasks` to get the list of tasks with short descriptions.
@@ -82,11 +81,11 @@
# Filter by a key pattern
i18n-tasks find 'auth.*'
i18n-tasks find '{number,currency}.format.*'
```
-
+![i18n-screenshot][screenshot-find]
Relative keys (`t '.title'`) and plural keys (key.one/many/other/etc) are fully supported.
Scope argument is supported, but only when it is the first keyword argument ([this](/lib/i18n/tasks/scanners/pattern_with_scope_scanner.rb) can be improved):
@@ -118,11 +117,11 @@
so it is recommended to set locale settings explicitly:
```yaml
# config/i18n-tasks.yml
base_locale: en
-locales: [es, fr]
+locales: [es, fr] # This includes base_locale by default
```
### Storage
The default data adapter supports YAML and JSON files.
@@ -285,6 +284,15 @@
---
This was originally developed for [Zuigo](http://zuigo.com/), a platform to organize and discover events.
-[MIT license](/LICENSE.txt)
+[MIT license]: /LICENSE.txt
+[travis]: https://travis-ci.org/glebm/i18n-tasks
+[badge-travis]: https://travis-ci.org/glebm/i18n-tasks.png?branch=master
+[coveralls]: https://coveralls.io/r/glebm/i18n-tasks?branch=master
+[badge-coveralls]: https://coveralls.io/repos/glebm/i18n-tasks/badge.png?branch=master
+[code-climate]: https://codeclimate.com/github/glebm/i18n-tasks
+[badge-code-climate]: https://codeclimate.com/github/glebm/i18n-tasks.png
+[badge-flattr]: https://api.flattr.com/button/flattr-badge-large.png
+[flattr]: https://flattr.com/submit/auto?user_id=glebm&url=https%3A%2F%2Fgithub.com%2Fglebm%2Fi18n-tasks
+[screenshot-find]: https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-usages.png "i18n-tasks find output screenshot"