Skip to content

Commit e8a8706

Browse files
committed
docs: update README to replace image with GIF and add OpenAI API key instructions
1 parent 3192fd3 commit e8a8706

3 files changed

Lines changed: 6 additions & 1 deletion

File tree

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
Below is a sample execution of `commit-msg`:
1313

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

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

@@ -165,6 +165,11 @@ commit .
165165
2. Generate an API key
166166
3. Set the `GROK_API_KEY` environment variable
167167

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+
168173
---
169174

170175
## 🤝 Contributing

commit.gif

138 KB
Loading

image.png

-15.6 KB
Loading

0 commit comments

Comments
 (0)