Update README.md

Author: manyfacedqod

README.md

@@ -1,6 +1,6 @@
 # SmartCommit
 
-SmartCommit is a blazing-fast CLI tool that uses AI to generate meaningful Git commit messages from your staged changes — powered by local or remote LLMs (Ollama, OpenAI, Gemini or any HTTP-based LLM).
+**SmartCommit** is a blazing-fast CLI tool that uses AI to generate meaningful Git commit messages from your staged changes — powered by local or remote LLMs (Ollama, OpenAI, or any HTTP-based LLM).
 
 ---
 
@@ -10,57 +10,34 @@ SmartCommit is a blazing-fast CLI tool that uses AI to generate meaningful Git c
 * 🤖 Supports multiple LLM providers: Ollama, OpenAI, HTTP endpoints (Claude, Gemini, etc.)
 * ✏️ Customizable system prompt (edit in Vim)
 * ⚡ Interactive flow with options to commit, edit, regenerate, or quit
-* ⚡ One‑shot `--yes` flag for auto‑commit
+* ⚡ One‐shot `--yes` flag for auto‐commit
 * 📦 Single static binaries for Linux, macOS (Intel/ARM), and Windows
+* 🔖 `--version` flag and `version` subcommand
 
 ---
 
-## 📥 Quick Installation
+## 📥 Installation
 
-### 1. Prebuilt Binary (Recommended)
-(will soon add direct installs from brew/scoops soon)
-
-1. Go to [Releases](https://github.com/manyfacedqod/smartcommit/releases).
-2. Download the `.tar.gz` for your OS.
-3. Extract and move into your `PATH`:
-
-   * **Linux**
-
-     ```bash
-     tar -xzf smartcommit-linux.tar.gz
-     sudo mv smartcommit-linux /usr/local/bin/smartcommit
-     chmod +x /usr/local/bin/smartcommit
-     ```
-   * **macOS**
-
-     ```bash
-     tar -xzf smartcommit-macos.tar.gz
-     sudo mv smartcommit-macos /usr/local/bin/smartcommit
-     chmod +x /usr/local/bin/smartcommit
-     ```
-   * **Windows (Git Bash)**
-
-     ```bash
-     tar -xzf smartcommit-windows.tar.gz
-     mv smartcommit-windows.exe /usr/local/bin/smartcommit.exe
-     ```
-
-### 2. Go Install
+### Using Go
 
 ```bash
-go install github.com/manyfacedqod/smartcommit@v1.1.1
+go install github.com/manyfacedqod/smartcommit@latest
 ```
 
-Ensure `$GOPATH/bin` or `~/go/bin` is in your `PATH`.
+### Download Prebuilt Binary
 
-### 3. Build from Source
+1. Visit the [Releases page](https://github.com/manyfacedqod/smartcommit/releases).
+2. Download the `.tar.gz` for your OS and extract:
 
-```bash
-git clone https://github.com/manyfacedqod/smartcommit
-cd smartcommit
-go build -o smartcommit
-sudo mv smartcommit /usr/local/bin/
-```
+   ```bash
+   tar -xzf smartcommit-<os>.tar.gz
+   ```
+3. Move the binary into your `PATH`:
+
+   ```bash
+   mv smartcommit-<os> /usr/local/bin/smartcommit  # or equivalent
+   chmod +x /usr/local/bin/smartcommit
+   ```
 
 ---
 
@@ -70,12 +47,12 @@ sudo mv smartcommit /usr/local/bin/
 smartcommit setup
 ```
 
-You’ll be prompted to configure:
+Configure in an interactive prompt:
 
 1. **Provider**: `ollama`, `openai`, or `http`
 2. **Model name**: e.g., `llama3`, `gpt-4`, `gemini`
 3. **API Key** (HTTP/OpenAI) or **Base URL** (HTTP/Ollama)
-4. **System prompt** is saved to `~/.config/smartcommit/config.yaml`
+4. **System prompt** saved to `~/.config/smartcommit/config.yaml`
 
 ---
 
@@ -88,7 +65,7 @@ git add .
 smartcommit generate
 ```
 
-```
+```text
 💡 Generated Commit Message:
 fix: handle empty username in login flow
 
@@ -108,16 +85,17 @@ smartcommit generate --yes
 
 ### Config Commands
 
-* **Show current config**:
+```bash
+smartcommit config show   # display current config
+smartcommit config edit   # edit system prompt in $EDITOR
+```
 
-  ```bash
-  smartcommit config show
-  ```
-* **Edit system prompt (Vim)**:
+### Version
 
-  ```bash
-  smartcommit config edit
-  ```
+```bash
+smartcommit --version
+smartcommit version
+```
 
 ---
 
@@ -130,48 +108,50 @@ smartcommit generate --yes
 | `smartcommit generate --yes` | Auto‑generate & commit without prompt       |
 | `smartcommit config show`    | Display current configuration               |
 | `smartcommit config edit`    | Edit the system prompt using your `$EDITOR` |
-| `smartcommit --version`      | Show version (v1.1.1)                       |
+| `smartcommit --version`      | Show the CLI version                        |
+| `smartcommit version`        | Same as `--version`                         |
 
 ---
 
-## 👨‍💻 Open Source Contribution
+## 👨‍💻 Contributing
 
-We welcome contributions! Here’s how to get started:
+We welcome your contributions! 🚀
 
 1. **Fork** the repo and **clone** your fork:
 
    ```bash
-   git clone https://github.com/<your-user>/smartcommit
-   cd smartcommit
    ```
-2. **Create** a feature branch:
 
+git clone [https://github.com/](https://github.com/)<your-user>/smartcommit.git
+cd smartcommit
+
+````
+2. **Create** a feature branch:
    ```bash
-   git checkout -b feat/your-feature
-   ```
-3. **Implement** your changes, **add tests**, and **update docs** as needed.
-4. **Run** existing tests & build:
+git checkout -b feat/your-feature
+````
+
+3. **Make changes**, **add tests**, and **update docs**.
+4. **Run** tests & build:
 
    ```bash
    ```
 
 go test ./...
-go build -o smartcommit
+go build
 
 ```
-5. **Commit** and **push**, then open a **Pull Request** against `main`.
-
-### Contribution Guidelines
+5. **Commit**, **push**, and open a **Pull Request**.
 
-- Follow existing code style.
-- Write clear commit messages (`feat:`, `fix:`, `docs:`, etc.).
-- Include tests for new features.
-- Document changes in this `README.md` or code comments.
+### Guidelines
 
-Thank you for making SmartCommit better! 🙏
+- Follow existing code style and idioms.  
+- Use [Conventional Commits](https://www.conventionalcommits.org/) (`feat:`, `fix:`, `docs:`, etc.).  
+- Write clear tests for new features or fixes.  
+- Update this README when adding or changing commands.
 
 ---
-
+(*this one was kinda ai generated so might update this later*)
 ## 📄 License
 
 MIT License © manyfacedqod