Skip to content

Commit 9991131

Browse files
committed
Revise README for better instructions and formatting
1 parent 5bb4802 commit 9991131

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
# git-commit-message-agent
1+
# Git Commit Message 🔮 AI Agent
22

3-
Agent to generate Git Commit messages for you!
3+
This will generate Git Commit messages for you using an LLM:
44

55
1. First, make sure that you [have `uvx` available](https://docs.astral.sh/uv/getting-started/installation/#standalone-installer) (until #[1632](https://github.com/enola-dev/enola/issues/1632))
6-
1. Next, [create a Google Gemini API key](https://aistudio-preprod.corp.google.com/apikey)!
6+
1. Next, [create a Google Gemini API key](https://aistudio.google.com/apikey)
7+
1. Now [store this secret](https://docs.enola.dev/use/secret/), using: `mkdir -p ~/.config/enola && echo GOOGLE_AI_API_KEY=... >>~/.config/enola/azkaban.yaml`
78
1. Finally, [install Enola.dev](https://docs.enola.dev/use/), and now run:
89

910
```sh
10-
GOOGLE_AI_API_KEY=... enola ai --http-scheme --agents=https://raw.githubusercontent.com/enola-dev/git-commit-message-agent/refs/heads/main/git-commit-message.agent.yaml --in="Make it so!"
11+
enola ai --http-scheme --agents=https://raw.githubusercontent.com/enola-dev/git-commit-message-agent/refs/heads/main/git-commit-message.agent.yaml --in="Make it so!"
1112
```
13+
14+
We recommend that you create an `alias` for this in your [dotfiles](https://github.com/vorburger/vorburger-dotfiles-bin-etc/blob/main/dotfiles/alias), e.g. `ac` for _AI Commit!_

0 commit comments

Comments
 (0)