Skip to content

Commit 382021c

Browse files
committed
Updated name/cmd/config filename, stripped quotes, merged config file instructions
1 parent 4a95e04 commit 382021c

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

translate.py/docs/README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# translate-messages
1+
# translate.py
22

33
Translate `en/messages.json` to other locales automatically.
44

55
## Installation
66

77
```bash
8-
pip install translate-messages
8+
pip install translate.py
99
```
1010

1111
## Usage
1212

1313
Run the CLI:
1414
```bash
15-
translate-messages
15+
translate-py
1616
```
1717

1818
If no options are provided, the CLI will:
@@ -26,22 +26,21 @@ Customize behavior using command-line arguments:
2626

2727
| Option | Description |
2828
| ----------------- | ---------------------------------------------------------------- |
29-
| `--include-langs` | Comma-separated list of languages to include (e.g. `en,es,fr") |
30-
| `--exclude-langs` | Comma-separated list of languages to exclude (e.g. `"en,es"`) |
31-
| `--ignore-keys` | Comma-separated list of keys to ignore (e.g. `"appName,author"`) |
29+
| `--include-langs` | Comma-separated list of languages to include (e.g. `en,es,fr") |
30+
| `--exclude-langs` | Comma-separated list of languages to exclude (e.g. `en,es`) |
31+
| `--ignore-keys` | Comma-separated list of keys to ignore (e.g. `appName,author`) |
3232
| `--locales-dir` | Name of the folder containing locale files (default: `_locales`) |
3333
| `--provider` | Translation provider to use |
34-
| `--init` | Create a .config.json file to store your defaults |
35-
| `--no-wizard` | Skip interactive prompts during start-up |
34+
| `--init` | Create a .config.json file to store your defaults |
35+
| `--no-wizard` | Skip interactive prompts during start-up |
3636

3737
## Config file
3838

39-
- Place `translate-messages.config.json` in your project root to set default options
40-
- Use `--init` to create it automatically
39+
- Use `--init` to create `translate.py.config.json` in your project root to set default options
4140
- CLI arguments always override config file
4241

4342
## Example
4443

4544
```bash
46-
translate-messages --include-langs=fr,es --ignore-keys=appName,author
45+
translate-py --include-langs=fr,es --ignore-keys=appName,author
4746
```

0 commit comments

Comments
 (0)