docs 📚 (README): update documentation for AI-generated commit messages

Signed-off-by: Zine Moualhi 🇵🇸 <zmoualhi@outlook.com>

Author: muandane

README.md

@@ -28,7 +28,12 @@ for selecting the type of change, scope, and description of your commit message.
 - Predefined commit types with corresponding emojis.
 - Customizable commit types and scopes through a JSON configuration file.
 - Supports Git out of the box
-- AI generated commit messages using [phind](https://phind.com) without needing API keys or tokens (possibility to use your own ai models will be planned).
+- AI generated commit messages using multiple providers:
+  - **Phind** (default, no API key required)
+  - **Groq** (fast inference, requires API key)
+  - **OpenRouter** (access to multiple models, requires API key)
+- Intelligent large diff handling with automatic summarization
+- No rate limiting issues with smart diff compression
 
 ## Install
 
@@ -109,20 +114,295 @@ To use the check command, add the following to your pre-commit hook in your git
 
 ## Draft command
 
-The `draft` command allows you to generate a commit message for staged changes using an AI provider.
+The `draft` command allows you to generate a commit message for staged changes using various AI providers.
 
 ```sh
 goji draft
 ```
 
-This command connects to an AI provider (e.g., Phind) to generate a commit message based on your staged changes.
+This command connects to an AI provider to generate a commit message based on your staged changes.
 
-Options for `draft` command:
+### Quick Start
+
+**1. Set up environment variables (if using Groq or OpenRouter):**
+
+```sh
+# For Groq
+export GROQ_API_KEY="your-groq-api-key"
+
+# For OpenRouter  
+export OPENROUTER_API_KEY="your-openrouter-api-key"
+
+# For Phind (no setup needed)
+```
+
+**2. Generate and commit:**
+
+```sh
+git add .
+goji draft --commit
+```
+
+### Basic Usage
+
+```sh
+# Generate a commit message (interactive)
+goji draft
+
+# Generate and commit directly
+goji draft --commit
+
+# Generate with detailed body
+goji draft --body
+
+# Generate and commit with detailed body
+goji draft --body --commit
+```
+
+### Command Options
 
 - `-c`, `--commit`: Commit the generated message directly.
+- `-b`, `--body`: Generate a detailed commit message with body.
 - `-t`, `--type`: Override the commit type (e.g., feat, fix, docs).
 - `-s`, `--scope`: Override the commit scope (e.g., api, ui, core).
 
+### AI Providers
+
+Goji supports multiple AI providers for generating commit messages. Configure your preferred provider in the `.goji.json` file:
+
+#### 1. Phind (Default - No API Key Required)
+
+Phind is the default provider and doesn't require any API keys.
+
+```json
+{
+  "aiprovider": "phind",
+  "aichoices": {
+    "phind": {
+      "model": "Phind-70B"
+    }
+  }
+}
+```
+
+#### 2. Groq
+
+Fast inference with various models. Requires a Groq API key.
+
+**Setup:**
+
+```sh
+export GROQ_API_KEY="your-groq-api-key"
+```
+
+**Configuration:**
+
+```json
+{
+  "aiprovider": "groq",
+  "aichoices": {
+    "groq": {
+      "model": "mixtral-8x7b-32768"
+    }
+  }
+}
+```
+
+**Available Models:**
+
+- `mixtral-8x7b-32768` (default)
+- `llama2-70b-4096`
+- `llama2-13b-chat`
+- `gemma-7b-it`
+
+#### 3. OpenRouter
+
+Access to multiple AI models through a single API. Requires an OpenRouter API key.
+
+**Setup:**
+
+```sh
+export OPENROUTER_API_KEY="your-openrouter-api-key"
+```
+
+**Configuration:**
+
+```json
+{
+  "aiprovider": "openrouter",
+  "aichoices": {
+    "openrouter": {
+      "model": "anthropic/claude-3.5-sonnet"
+    }
+  }
+}
+```
+
+**Available Models:**
+
+- `anthropic/claude-3.5-sonnet` (default)
+- `openai/gpt-4o`
+- `openai/gpt-4o-mini`
+- `meta-llama/llama-3.1-405b-instruct`
+- `google/gemini-pro-1.5`
+
+### Large Diff Handling
+
+Goji automatically handles large diffs using intelligent summarization:
+
+- **Small diffs** (<20k chars): Processed normally
+- **Large diffs** (>20k chars): Automatically summarized to key changes only
+- **Smart compression**: Reduces large diffs by 90%+ while preserving important context
+- **No rate limits**: Single API call prevents token limit issues
+
+### Examples
+
+**Basic commit generation:**
+
+```sh
+# Stage your changes
+git add .
+
+# Generate commit message
+goji draft
+
+# Generate and commit directly
+goji draft --commit
+```
+
+**Detailed commit with body:**
+
+```sh
+# Generate detailed commit with body
+goji draft --body --commit
+```
+
+**Override type and scope:**
+
+```sh
+# Force a specific type and scope
+goji draft --type feat --scope api --commit
+```
+
+**Using different AI providers:**
+
+```sh
+# Switch to Groq (requires GROQ_API_KEY)
+goji draft --commit
+
+# Switch to OpenRouter (requires OPENROUTER_API_KEY)  
+goji draft --commit
+```
+
+### Configuration
+
+Update your `.goji.json` to configure AI providers:
+
+```json
+{
+  "aiprovider": "groq",
+  "aichoices": {
+    "phind": {
+      "model": "Phind-70B"
+    },
+    "groq": {
+      "model": "mixtral-8x7b-32768"
+    },
+    "openrouter": {
+      "model": "anthropic/claude-3.5-sonnet"
+    }
+  }
+}
+```
+
+### Environment Variables
+
+Goji uses environment variables to authenticate with AI providers. Set these in your shell profile (`.bashrc`, `.zshrc`, etc.) or export them before running commands.
+
+#### Required Environment Variables
+
+| Provider | Environment Variable | Required | Description |
+|----------|---------------------|----------|-------------|
+| **Phind** | None | ❌ | Works out of the box |
+| **Groq** | `GROQ_API_KEY` | ✅ | Get from [Groq Console](https://console.groq.com) |
+| **OpenRouter** | `OPENROUTER_API_KEY` | ✅ | Get from [OpenRouter](https://openrouter.ai) |
+
+**For Groq:**
+
+```sh
+export GROQ_API_KEY="your-groq-api-key"
+```
+
+**For OpenRouter:**
+
+```sh
+export OPENROUTER_API_KEY="your-openrouter-api-key"
+```
+
+**For Phind:**
+
+```sh
+# No environment variables required - works out of the box
+```
+
+#### Setting Environment Variables
+
+**Temporary (current session only):**
+
+```sh
+export GROQ_API_KEY="your-api-key"
+goji draft --commit
+```
+
+**Permanent (add to shell profile):**
+
+```sh
+# Add to ~/.bashrc, ~/.zshrc, or ~/.profile
+echo 'export GROQ_API_KEY="your-api-key"' >> ~/.bashrc
+source ~/.bashrc
+```
+
+**Using .env files (if supported by your shell):**
+
+```sh
+# Create .env file in your project root
+echo "GROQ_API_KEY=your-api-key" > .env
+```
+
+#### Verifying Environment Variables
+
+Check if your environment variables are set:
+
+```sh
+echo $GROQ_API_KEY
+echo $OPENROUTER_API_KEY
+```
+
+### Troubleshooting
+
+**Rate limiting issues:**
+
+- Goji automatically handles large diffs with smart summarization
+- No need to worry about token limits or rate limiting
+
+**API key issues:**
+
+- Ensure your API key is set in the environment
+- Check that the provider is correctly configured in `.goji.json`
+- Verify environment variables with `echo $VARIABLE_NAME`
+
+**Large diff processing:**
+
+- Goji will show: `🔍 Large diff detected: X chars, using aggressive summarization`
+- Summary shows compression: `📊 Summarized to Y chars (Z% reduction)`
+
+**Common environment variable issues:**
+
+- **Variable not found**: Make sure to export the variable in your current shell session
+- **Wrong variable name**: Check spelling (GROQ_API_KEY, not GROQ_KEY)
+- **Shell restart needed**: Some shells require restarting after adding to profile
+- **Case sensitivity**: Environment variable names are case-sensitive
+
 ## Customization
 
 By default `goji` comes ready to run out of the box and you can initialize a config file with commands. _For now customization is in the works (?)_