[docs] Update the documents

Author: forfudan

LICENSE

@@ -1,4 +1,3 @@
-
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/

README.md

@@ -12,43 +12,47 @@ A command-line argument parser library for [Mojo](https://www.modular.com/mojo).
 
 ## Overview
 
-ArgMojo provides a builder-pattern API for defining and parsing command-line arguments in Mojo. It supports:
-
-[x] **Long options**: `--verbose`, `--output file.txt`, `--output=file.txt`
-[x] **Short options**: `-v`, `-o file.txt`
-[x] **Boolean flags**: options that take no value
-[x] **Positional arguments**: matched by position
-[x] **Default values**: fallback when an argument is not provided
-[x] **Required arguments**: validation that mandatory args are present
-[x] **Auto-generated help**: `--help` / `-h` (no need to implement manually)
-[x] **Version display**: `--version` / `-V` (also auto-generated)
-[x] **`--` stop marker**: everything after `--` is treated as positional
-[x] **Short flag merging**: `-abc` expands to `-a -b -c`
-[x] **Attached short values**: `-ofile.txt` means `-o file.txt`
-[x] **Choices validation**: restrict values to a set (e.g., `json`, `csv`, `table`)
-[x] **Metavar**: custom display name for values in help text
-[x] **Hidden arguments**: exclude internal args from `--help` output
-[x] **Count flags**: `-vvv` → `get_count("verbose") == 3`
-[x] **Positional arg count validation**: reject extra positional args
-[x] **Negatable flags**: `--color` / `--no-color` paired flags with `.negatable()`
-[x] **Mutually exclusive groups**: prevent conflicting flags (e.g., `--json` vs `--yaml`)
-[x] **Required-together groups**: enforce that related flags are provided together (e.g., `--username` + `--password`)
-[x] **Long option prefix matching**: allow abbreviated options (e.g., `--verb` → `--verbose`). If the prefix is ambiguous (e.g., `--ver` could match both `--verbose` and `--version`), an error is raised.
+ArgMojo provides a builder-pattern API for defining and parsing command-line arguments in Mojo. It currently supports:
+
+- **Long options**: `--verbose`, `--output file.txt`, `--output=file.txt`
+- **Short options**: `-v`, `-o file.txt`
+- **Boolean flags**: options that take no value
+- **Positional arguments**: matched by position
+- **Default values**: fallback when an argument is not provided
+- **Required arguments**: validation that mandatory args are present
+- **Auto-generated help**: `--help` / `-h` (no need to implement manually)
+- **Version display**: `--version` / `-V` (also auto-generated)
+- **`--` stop marker**: everything after `--` is treated as positional
+- **Short flag merging**: `-abc` expands to `-a -b -c`
+- **Attached short values**: `-ofile.txt` means `-o file.txt`
+- **Choices validation**: restrict values to a set (e.g., `json`, `csv`, `table`)
+- **Metavar**: custom display name for values in help text
+- **Hidden arguments**: exclude internal args from `--help` output
+- **Count flags**: `-vvv` → `get_count("verbose") == 3`
+- **Positional arg count validation**: reject extra positional args
+- **Negatable flags**: `--color` / `--no-color` paired flags with `.negatable()`
+- **Mutually exclusive groups**: prevent conflicting flags (e.g., `--json` vs `--yaml`)
+- **Required-together groups**: enforce that related flags are provided together (e.g., `--username` + `--password`)
+- **Long option prefix matching**: allow abbreviated options (e.g., `--verb` → `--verbose`). If the prefix is ambiguous (e.g., `--ver` could match both `--verbose` and `--version`), an error is raised.
 
 ---
 
 I created this project to support my experiments with a CLI-based Chinese character search engine in Mojo, as well as a CLI-based calculator for [DeciMojo](https://github.com/forfudan/decimojo). It is inspired by Python's `argparse`, Rust's `clap`, Go's `cobra`, and other popular argument parsing libraries, but designed to fit Mojo's unique features and constraints.
 
+My goal is to provide a Mojo-idiomatic argument parsing library that can be easily adopted by the growing Mojo community for their CLI applications. **Before Mojo v1.0** (which means it gets stable), my focus is on building core features and ensuring correctness. "Core features" refer to those who appear in `argparse`/`clap`/`cobra` and are commonly used in CLI apps. "Correctness" means that the library should handle edge cases properly, provide clear error messages, and have good test coverage. Some fancy features will depend on my time and interest.
+
 ## Installation
 
-ArgMojo requires Mojo >= 0.26.1 and uses [pixi](https://pixi.sh) for environment management.
+ArgMojo requires Mojo == 0.26.1 and uses [pixi](https://pixi.sh) for environment management.
 
 ```bash
 git clone https://github.com/forfudan/argmojo.git
 cd argmojo
 pixi install
 ```
 
+I make the Mojo version strictly 0.26.1 because that's the version I developed and tested on, and Mojo is rapidly evolving. Based on my experience, the library will not work every time there's a new Mojo release.
+
 ## Quick Start
 
 Here is a simple example of how to use ArgMojo in a Mojo program. The full example can be found in `examples/demo.mojo`.
@@ -58,7 +62,7 @@ from argmojo import Arg, Command
 
 
 fn main() raises:
-    var cmd = Command("sou", "A CJK-aware text search tool", version="0.1.0")
+    var cmd = Command("demo", "A CJK-aware text search tool that supports Pinyin and Yuhao Input Methods (宇浩系列輸入法).", version="0.1.0")
 
     # Positional arguments
     cmd.add_arg(Arg("pattern", help="Search pattern").positional().required())
@@ -213,7 +217,7 @@ Some arguments are excluded from `--help` but still work at the command line (us
 ### A mock example showing how features work together
 
 ```bash
-./demo yes ./src --li --color --no-color --usern zhu --pas 12345
+./demo yes ./src --verbo --color -li -d 3 --no-color --usern zhu --pas 12345
 ```
 
 This will be parsed as:
@@ -264,7 +268,7 @@ argmojo/
 │       ├── command.mojo            # Command struct (parsing logic)
 │       └── result.mojo             # ParseResult struct (parsed values)
 ├── tests/
-│   └── test_argmojo.mojo          # Tests
+│   └── test_argmojo.mojo           # Tests
 ├── pixi.toml                       # pixi configuration
 ├── .gitignore
 ├── LICENSE

docs/argmojo_overall_planning.md

@@ -156,7 +156,7 @@ fn main() raises:
     cmd.add_arg(Arg("path", help="Search path").positional().default("."))
 
     # Optional arguments
-    cmd.add_arg(Arg("ling", help="Use Yuho Lingming encoding").long("ling").short("l").flag())
+    cmd.add_arg(Arg("ling", help="Use Yuhao Lingming encoding").long("ling").short("l").flag())
     cmd.add_arg(Arg("ignore-case", help="Case insensitive search").long("ignore-case").short("i").flag())
     cmd.add_arg(Arg("max-depth", help="Maximum directory depth").long("max-depth").short("d").takes_value())
 
@@ -200,7 +200,7 @@ pattern             # By order of add_arg() calls
 - [x] Establish module structure
 - [x] Implement `Arg` struct and builder methods
 - [x] Implement basic `Command` struct
-- [x] Iimplement a small demo CLI tool to test the library
+- [x] Implement a small demo CLI tool to test the library
 
 ### Phase 2: Parsing Enhancements ✓
 
@@ -213,7 +213,7 @@ pattern             # By order of add_arg() calls
 - [x] **`count` action** — `-vvv` → `get_count("verbose") == 3` (argparse `-v` counting)
 - [x] **Clean exit for --help/--version** — use `sys.exit(0)` instead of `raise Error`
 
-### Phase 3: Relationships & Validation (for v0.1)
+### Phase 3: Relationships & Validation (for v0.2)
 
 - [x] **Mutually exclusive flags** — `cmd.mutually_exclusive(["json", "yaml", "toml"])`
 - [x] **Flags required together** — `cmd.required_together(["username", "password"])`
@@ -224,7 +224,7 @@ pattern             # By order of add_arg() calls
 - [ ] **Aliases** for long names — `.aliases(["colour"])` for `--color`
 - [ ] **Deprecated arguments** — `.deprecated("Use --format instead")` prints warning (argparse 3.13)
 
-### Phase 4: Subcommands (maybe for v0.2)
+### Phase 4: Subcommands (maybe for v0.3)
 
 - [ ] **Subcommand support** — `app <subcommand> [args]` (cobra, argparse, clap)
 - [ ] **Subcommand help** — `app help <subcommand>` or `app <subcommand> --help`
@@ -239,7 +239,7 @@ pattern             # By order of add_arg() calls
 
 ### Explicitly Out of Scope
 
-These will **NOT** be implemented:
+These will **NOT** be implemented (but who knows :D maybe in the future if there's demand):
 
 - Derive/decorator-based API (no macros in Mojo)
 - Shell completion script generation
@@ -279,9 +279,11 @@ Input: ["demo", "yuhao", "./src", "--ling", "-i", "--max-depth", "3"]
 6. Return ParseResult
 ```
 
-## 8. Mojo 0.26.1 Notes
+## 8. Notes on Mojo versions
 
-Here are some important Mojo-specific patterns used throughout this project. Mojo is rapidly evolving, so these may need to be updated in the future:
+Here are some important Mojo-specific patterns used throughout this project. Mojo is rapidly evolving, so these may need to be updated in the future.
+
+These are all worthy being checked in [Mojo Miji](https://mojo-lang.com/miji) too.
 
 | Pattern                | What & Why                                          |
 | ---------------------- | --------------------------------------------------- |

pixi.toml

@@ -5,7 +5,7 @@ channels = [
   "https://repo.prefix.dev/modular-community",
   "conda-forge",
 ]
-description = "A command-line argument parser library for Mojo, inspired by Rust's clap"
+description = "A command-line argument parser library for Mojo"
 license = "Apache-2.0"
 name = "argmojo"
 platforms = ["osx-arm64", "linux-64"]

src/argmojo/arg.mojo

@@ -7,6 +7,7 @@ struct Arg(Copyable, Movable, Stringable, Writable):
     Use the builder pattern to configure the argument:
 
     ```mojo
+    from argmojo import Arg
     var arg = Arg("output", help="Output file path").long("output").short("o").takes_value()
     ```
     """

src/argmojo/command.mojo

@@ -12,6 +12,7 @@ struct Command(Stringable, Writable):
     Example:
 
     ```mojo
+    from argmojo import Command, Arg
     var cmd = Command("myapp", "A sample application")
     cmd.add_arg(Arg("verbose", help="Enable verbose output").long("verbose").short("v").flag())
     var result = cmd.parse()

tests/test_argmojo.mojo

@@ -1,4 +1,4 @@
-"""Testss for argmojo — command-line argument parser."""
+"""Tests for argmojo — command-line argument parser."""
 
 from testing import assert_true, assert_false, assert_equal, TestSuite
 from argmojo import Arg, Command, ParseResult