README.md in yaml-validator-0.1.9 vs README.md in yaml-validator-0.1.10
- old
+ new
@@ -1,15 +1,31 @@
YAML Validator
==============
+
[](https://travis-ci.org/wazeHQ/yaml-validator)
Validates .yml locale files for Ruby on Rails projects.
What does it validate?
----------------------
+* Rails I18n variables:
+
+ * Make sure users didn't translate the variables (e.g. `Hi %{user}` was translated to `Hola %{usuario}`).
+ * Make sure users didn't write invalid variable syntax (e.g. `{name}` or `{name}%` instead of `%{name}`)
+
+* Make sure users didn't change locked keys (searches for a file named `locked_keys` in the same folder, where each line is a regular expression).
+* Check for bad characters in values (transifex sometimes adds the "⏎ " character)
+* Keys that don't appear in the source language
+* Checks that Ruby's YAML parser can parse the file
+* Checks for missing pluralization (in languages like russian there are 4 types of pluralization: one, other, few, many)
+
+
+How to run it?
+----------------------
+
Given the following file tree:
```
config/
locales/
@@ -21,10 +37,10 @@
```
Run the following command:
```bash
-yaml-validator config/locales
+yaml-validator validate config/locales
or
cd config/locales
yaml-validator