@@ -20,6 +20,7 @@ Before running the application, ensure you have set the system environment varia
2020This project is participating in ** Hacktoberfest 2025** ! We welcome contributions from developers of all skill levels.
2121
2222Looking to contribute? Check out:
23+
2324- [ Good First Issues] ( https://github.com/dfanso/commit-msg/labels/good%20first%20issue )
2425- [ Help Wanted Issues] ( https://github.com/dfanso/commit-msg/labels/help%20wanted )
2526- [ Contributing Guidelines] ( CONTRIBUTING.md )
@@ -32,20 +33,20 @@ Looking to contribute? Check out:
3233📋 ** Auto-Copy to Clipboard** - Generated messages are automatically copied for instant use
3334📊 ** File Statistics Display** - Visual preview of changed files and line counts
3435🚀 ** Easy to Use** - Simple CLI interface with beautiful terminal UI
35- ⚡ ** Fast** - Quick generation of commit messages
36+ ⚡ ** Fast** - Quick generation of commit messages
3637
3738## Supported LLM Providers
3839
3940You can use either ** Google Gemini** or ** Grok** as the LLM to generate commit messages:
4041
4142### Environment Variables
4243
43- | Variable | Values | Description |
44- | ----------| --------| -------------|
45- | ` COMMIT_LLM ` | ` gemini ` , ` grok ` , or ` chatgpt ` | Choose your LLM provider |
46- | ` GEMINI_API_KEY ` | Your API key | Required if using Gemini |
47- | ` GROK_API_KEY ` | Your API key | Required if using Grok |
48- | ` OPENAI_API_KEY ` | Your API key | Required if using ChatGPT |
44+ | Variable | Values | Description |
45+ | ---------------- | ---------------------------------------- | ------------------------- |
46+ | ` COMMIT_LLM ` | ` gemini ` , ` grok ` , ` claude ` , or ` chatgpt ` | Choose your LLM provider |
47+ | ` GEMINI_API_KEY ` | Your API key | Required if using Gemini |
48+ | ` GROK_API_KEY ` | Your API key | Required if using Grok |
49+ | ` OPENAI_API_KEY ` | Your API key | Required if using ChatGPT |
4950
5051---
5152
@@ -58,11 +59,13 @@ You can use either **Google Gemini** or **Grok** as the LLM to generate commit m
58593 . Add the directory to your system PATH:
5960
6061 ** Windows:**
62+
6163 ``` cmd
6264 setx PATH "%PATH%;C:\path\to\commit-msg"
6365 ```
6466
6567 ** Linux/macOS:**
68+
6669 ``` bash
6770 export PATH=$PATH :/path/to/commit-msg
6871 echo ' export PATH=$PATH:/path/to/commit-msg' >> ~ /.bashrc # or ~/.zshrc
@@ -71,12 +74,14 @@ You can use either **Google Gemini** or **Grok** as the LLM to generate commit m
71744 . Set up environment variables:
7275
7376 ** Windows:**
77+
7478 ``` cmd
7579 setx COMMIT_LLM "gemini"
7680 setx GEMINI_API_KEY "your-api-key-here"
7781 ```
7882
7983 ** Linux/macOS:**
84+
8085 ``` bash
8186 export COMMIT_LLM=gemini
8287 export GEMINI_API_KEY=your-api-key-here
@@ -156,16 +161,19 @@ commit .
156161### Getting API Keys
157162
158163** Google Gemini:**
164+
1591651 . Visit [ Google AI Studio] ( https://makersuite.google.com/app/apikey )
1601662 . Create a new API key
1611673 . Set the ` GEMINI_API_KEY ` environment variable
162168
163169** Grok (X.AI):**
170+
1641711 . Visit [ X.AI Console] ( https://console.x.ai/ )
1651722 . Generate an API key
1661733 . Set the ` GROK_API_KEY ` environment variable
167174
168175** OpenAI (ChatGPT):**
176+
1691771 . Visit [ OpenAI Platform] ( https://platform.openai.com/api-keys )
1701782 . Create a new API key
1711793 . Set the ` OPENAI_API_KEY ` environment variable
@@ -219,7 +227,3 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
219227---
220228
221229Made with ❤️ for Hacktoberfest 2025
222-
223-
224-
225-
0 commit comments