Skip to content

Commit de8d9cb

Browse files
authored
Improved config file section
1 parent 59976f3 commit de8d9cb

1 file changed

Lines changed: 17 additions & 4 deletions

File tree

translate-messages/README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ translate-msgs
1919

2020
If no options are provided, the CLI will:
2121
1. Prompt for `en/messages.json` keys to ignore
22-
2. Search for closest `_locales` directory
22+
2. Auto-discover closest `_locales` directory
2323
3. Translate `en/messages.json` to target languages
2424

2525
## Options
2626

27-
Options can be set using command-line arguments:
27+
Options can be set by using command-line arguments:
2828

2929
| Option | Description | Example
3030
| ----------------- | ---------------------------------------------------------------------|--------------------------------
@@ -37,8 +37,21 @@ Options can be set using command-line arguments:
3737

3838
## Config file
3939

40-
- Use `--init` to create `translate-messages.config.json` in your project root to set default options
41-
- CLI arguments always override config file
40+
Use `--init` to create `translate-messages.config.json` in your project root to set default options.
41+
42+
Example defaults:
43+
44+
```json
45+
{
46+
"include_langs": "",
47+
"exclude_langs": "",
48+
"ignore_keys": "",
49+
"locales_dir": "_locales",
50+
"no_wizard": false
51+
}
52+
```
53+
54+
###### _Note: CLI arguments always override config file._
4255

4356
## Example
4457

0 commit comments

Comments
 (0)