Skip to content

Commit 0327b7d

Browse files
authored
Merge pull request #18 from DFanso/dev
Dev
2 parents 9b44427 + 3e4fedc commit 0327b7d

4 files changed

Lines changed: 8 additions & 1 deletion

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,4 @@ go.work
2323
commit-helper.json
2424
HACKTOBERFEST_SETUP.md
2525
PR_DESCRIPTION.md
26+
commit

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@
44
[![Go Version](https://img.shields.io/badge/Go-1.23.4-blue.svg)](https://golang.org/)
55
[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
66
![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/DFanso/commit-msg?utm_source=oss&utm_medium=github&utm_campaign=DFanso%2Fcommit-msg&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)
7+
78
`commit-msg` is a command-line tool that generates commit messages using LLM (Large Language Models). It is designed to help developers create clear and concise commit messages for their Git repositories automatically by analyzing your staged changes.
89

910
## Screenshot
1011

1112
Below is a sample execution of `commit-msg`:
1213

13-
![Commit-msg Screenshot](image.png)
14+
![Commit-msg GIF](commit.gif)
1415

1516
Before running the application, ensure you have set the system environment variables. and add commit.exe to path variables (same for linux macOS)
1617

@@ -164,6 +165,11 @@ commit .
164165
2. Generate an API key
165166
3. Set the `GROK_API_KEY` environment variable
166167

168+
**OpenAI (ChatGPT):**
169+
1. Visit [OpenAI Platform](https://platform.openai.com/api-keys)
170+
2. Create a new API key
171+
3. Set the `OPENAI_API_KEY` environment variable
172+
167173
---
168174

169175
## 🤝 Contributing

commit.gif

138 KB
Loading

image.png

-15.6 KB
Loading

0 commit comments

Comments
 (0)