From 53a4b0c9a1d8c440f8a11023dba12b2fcfade696 Mon Sep 17 00:00:00 2001
From: HitBlast <hitblastlive@gmail.com>
Date: Tue, 6 Aug 2024 00:49:01 +0600
Subject: [PATCH] added command alias

---
 README.md      | 11 ++++++-----
 pyproject.toml |  1 +
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 03b2918..434400b 100644
--- a/README.md
+++ b/README.md
@@ -58,23 +58,24 @@ $ pip install avnie
 
 ## 🚀 Usage
 
-The usage of the interface within avnie is pretty straightforward. You can use the following commands to get started:
+The usage of avnie is pretty straightforward. You can either use `avro` or `avnie` as the keyword for executing avnie commands. Here are some examples:
 
 ```sh
 # Get basic help regarding usage.
 # This also provides additional functionality like autocompletion (TBA).
 $ avnie --help
+$ avro --help  # or
 
 # Parse a given English text to Bengali.
-$ avnie parse "ami banglay gan gaite bhalobasi"
+$ avro parse "ami banglay gan gaite bhalobasi"
 
 # Reverse a given Bengali text to English.
-$ avnie reverse "আমি বাংলায় গান গাইতে ভালবাসি"
+$ avro reverse "আমি বাংলায় গান গাইতে ভালবাসি"
 ```
 
 More commands and features will be available as the project progresses in its development phase. For now, you can use the commands above to get started with the basic functionalities. Additional options can be found by running `avnie <command> --help`.
 
-Some universal flags for each commands include:
+Some **universal flags** for each commands include:
 ```sh
 # Automatically copy the output to clipboard.
 $ avnie parse "oiTa ke?" --copy-on-success  # or -c
@@ -84,7 +85,7 @@ $ avnie parse --from-clip # or -f
 
 # Toggle between remap and full manual mode.
 $ avnie parse "wikipedia"  # remap
-$ avnie parse "wikipedia" -r  # no remap
+$ avnie parse "wikipedia" --ignore-remap  # no remap (can also use --i)
 
 # Convert to Bijoy on output.
 $ avnie parse "আমি বাংলায় গান গাইতে ভালবাসি" --bijoy  # or -b
diff --git a/pyproject.toml b/pyproject.toml
index 72000e6..c7be8d3 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -10,6 +10,7 @@ readme = "README.md"
 
 [tool.poetry.scripts]
 avnie = "avnie.cli:run"
+avro = "avnie.cli:run"
 
 [tool.poetry.dependencies]
 python = "^3.8"