README.md in aigu-0.2.1 vs README.md in aigu-0.3
- old
+ new
@@ -25,33 +25,48 @@
```bash
$ aigu export --locale=fr --input-directory=config/locales --output-file=my-project.json
```
-### Options
+#### Options
| Option | Description |
|-------------------|---------------------------------------------------------------------------------------------------------------------------|
| `locale` | The locale used to find localization files. Files that match `*.<locale>.yml` in the input directory will be processed. |
| `input-directory` | The directory used to find localization files |
| `output-file` | The path to the JSON file that will be written by `aigu` |
+| `ignore` | The patterns `aigu` will use to skip ignored files (eg. `routes.yml`)
### Importing the JSON file from Accent
The `import` command takes a generated JSON file from Accent and generates
the original YAML file structure.
```bash
$ aigu import --locale=fr --input-file=file-from-accent.json --output-directory=config/locales
```
-### Options
+#### Options
| Option | Description |
|--------------------|---------------------------------------------------------------------------------------------------|
| `locale` | The locale used to generate localization files. Files will be generated as `<file>.<locale>.yml` |
| `input-file` | The path to the Accent-generated JSON file |
| `output-directory` | The directory where the localization YAML files will be generated |
+
+### Using `aigu.yml`
+
+Instead of using command-line arguments when running the `aigu` command, you
+can create a `aigu.yml` file at the root of your project and hard-code options
+in that file.
+
+```yaml
+ignore:
+ - routes.yml
+ - rails/**/*.yml
+output-directory: config/locales
+input-directory: config/locales
+```
## License
`Aigu` is © 2014 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause). See the [`LICENSE.md`](https://github.com/mirego/aigu/blob/master/LICENSE.md) file.