Skip to content

Commit c6e3552

Browse files
committed
docs: update README with clipboard and enhanced UI features
- Add clipboard auto-copy feature to features list - Document ChatGPT support in environment variables - Update usage example to include new UI features - Add visual features to use cases - Enhance feature descriptions with emojis
1 parent cf611c7 commit c6e3552

1 file changed

Lines changed: 14 additions & 4 deletions

File tree

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,11 @@ Looking to contribute? Check out:
2626
## Features
2727

2828
**AI-Powered Commit Messages** - Automatically generate meaningful commit messages
29-
🔄 **Multiple LLM Support** - Choose between Google Gemini or Grok
29+
🔄 **Multiple LLM Support** - Choose between Google Gemini, Grok, or ChatGPT
3030
📝 **Context-Aware** - Analyzes staged and unstaged changes
31-
🚀 **Easy to Use** - Simple CLI interface
31+
📋 **Auto-Copy to Clipboard** - Generated messages are automatically copied for instant use
32+
📊 **File Statistics Display** - Visual preview of changed files and line counts
33+
🚀 **Easy to Use** - Simple CLI interface with beautiful terminal UI
3234
**Fast** - Quick generation of commit messages
3335

3436
## Supported LLM Providers
@@ -39,9 +41,10 @@ You can use either **Google Gemini** or **Grok** as the LLM to generate commit m
3941

4042
| Variable | Values | Description |
4143
|----------|--------|-------------|
42-
| `COMMIT_LLM` | `gemini` or `grok` | Choose your LLM provider |
44+
| `COMMIT_LLM` | `gemini`, `grok`, or `chatgpt` | Choose your LLM provider |
4345
| `GEMINI_API_KEY` | Your API key | Required if using Gemini |
4446
| `GROK_API_KEY` | Your API key | Required if using Grok |
47+
| `OPENAI_API_KEY` | Your API key | Required if using ChatGPT |
4548

4649
---
4750

@@ -128,15 +131,22 @@ git add .
128131
# Generate commit message
129132
commit .
130133

134+
# The tool will display:
135+
# - File statistics (staged, unstaged, untracked)
136+
# - Generated commit message in a styled box
137+
# - Automatically copy to clipboard
131138
# Output: "feat: add hello world console log to app.js"
139+
# You can now paste it with Ctrl+V (or Cmd+V on macOS)
132140
```
133141

134142
### Use Cases
135143

136144
- 📝 Generate commit messages for staged changes
137145
- 🔍 Analyze both staged and unstaged changes
138-
- 📊 Get context from recent commits
146+
- 📊 Get context from recent commits and file statistics
139147
- ✅ Create conventional commit messages
148+
- 📋 Auto-copy to clipboard for immediate use
149+
- 🎨 Beautiful terminal UI with file statistics and previews
140150

141151
---
142152

0 commit comments

Comments
 (0)