Skip to content

Commit 029f2c5

Browse files
committed
Update README for manual installation and Go requirements
1 parent f315453 commit 029f2c5

1 file changed

Lines changed: 11 additions & 6 deletions

File tree

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,19 @@ This repository includes a custom Git commit message hook powered by OpenAI. The
1818
curl -fsSL https://raw.githubusercontent.com/inem/dotdotdot/refs/heads/main/install.sh | sh
1919
```
2020

21-
## Regular Installation
21+
## Manual Installation (Go version)
2222

23-
1. Copy the `commit_msg` script to your repository's `.git/hooks/` directory as `commit-msg`.
24-
2. Make sure the script is executable:
23+
1. Clone this repository and enter the directory.
24+
2. Build the Go binary:
2525
```bash
26+
make build
27+
```
28+
3. Install the hook (this will overwrite `.git/hooks/commit-msg`):
29+
```bash
30+
cp _git/hooks/commit-msg .git/hooks/commit-msg
2631
chmod +x .git/hooks/commit-msg
2732
```
28-
3. Set your OpenAI API key in the environment:
33+
4. Set your OpenAI API key in the environment:
2934
```bash
3035
export OPENAI_API_KEY=your-api-key
3136
```
@@ -39,8 +44,8 @@ curl -fsSL https://raw.githubusercontent.com/inem/dotdotdot/refs/heads/main/inst
3944

4045
## Requirements
4146

42-
- Ruby
43-
- The `openai` Ruby gem (`gem install openai`) → openai-0.10.0
47+
- Go 1.21+
48+
- The `github.com/sashabaranov/go-openai` Go module (installed automatically by `make build`)
4449
- An OpenAI API key
4550

4651
## Notes

0 commit comments

Comments
 (0)