From 13c909d57fb1152d1700544dc0028013c12cf3b5 Mon Sep 17 00:00:00 2001
From: "Jean-Michel G." <49202412+Tripouille@users.noreply.github.com>
Date: Mon, 2 Dec 2024 21:50:04 +0100
Subject: [PATCH] docs: update README to include available commands and options
 (#4)

---
 README.md | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 456920a..498067e 100644
--- a/README.md
+++ b/README.md
@@ -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
@@ -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                                                     |