Skip to content

Commit

Permalink
Update README.md (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
guibranco authored Sep 17, 2024
1 parent b89e6c5 commit ef27e73
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,40 @@

---

## What does I do
## What this tool do

Generates a commit message based on `git diff` result using the [OpenAI](https://platform.openai.com/docs/overview) API.

---

## Getting started

1. Install the tool globally (or per project/repositoy).
2. Move to the project folder.
3. Install the Git hook on the default `hooks` directory.

```ps
dotnet tool install -g AiCommitMessage
cd my-project/
dotnet-aicommitmessage install-hook
git add .
git commit -m ""
```

1. Install the tool globally.
2. Move to the project folder.
3. Install the Git hook on the default `hooks` directory.
---

## Requirements

- OpenAI API key.
- .NET 8.0 (or higher) runtime.
- GIT client.

---

## Commit message pattern

The training model for the AI used is designed using as reference these two guidelines:

- [Conventional Commits v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/).
- [Padrões de Commits](https://github.com/tiagolofi/padroes-de-commits) (in Portuguese).

0 comments on commit ef27e73

Please sign in to comment.