Skip to content

Commit

Permalink
docs: update README to include available commands and options (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
Tripouille authored Dec 2, 2024
1 parent e4a12fd commit 13c909d
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ A CLI tool to synchronize and manage translations across multiple target files f
npm i -D @tripouille/i18n-cli
```

## Available commands

You can run --help to see the available commands.

| Command | Alias | Description | Options |
| ------- | ----- | ----------- | ------- |
| `status` | `s` | Show the status of the translation files | `-v, --verbose`: Show the tokens that require changes<br>`-vv, --very-verbose`: Show the tokens that require changes and the associated languages<br>`-foc, --fail-on-changes`: Fail if there are tokens that require changes |
| `sync` | - | Synchronize translation files | `-lr, --limit-retrieve <limit>`: Limit the number of tokens to retrieve |

## Usage

### Step 1: Create your CLI
Expand All @@ -33,10 +42,6 @@ bun run ./cli.ts status

This command will execute the `status` command of your CLI.

## Available commands

You can run --help to see the available commands.

## Create i18n CLI params

| Property | Required | Description |
Expand Down

0 comments on commit 13c909d

Please sign in to comment.