Skip to content

Commit

Permalink
Update README.md +semver: minor (#94)
Browse files Browse the repository at this point in the history
  • Loading branch information
guibranco authored Oct 22, 2024
1 parent 8231b48 commit 58ade13
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,23 @@ The training model for the AI used is designed using as reference these two guid

---

## Sequence of Execution

Here’s a flow diagram showing the sequence of execution of the `prepare-commit-msg` hook and its integration with `dotnet-aicommitmessage` to generate commit messages using the OpenAI API:

```mermaid
graph TD
A[Git Commit] --> B[prepare-commit-msg Hook Trigger]
B --> C[Invoke dotnet-aicommitmessage Tool]
C --> D[Send Data to OpenAI API]
D --> E[Generate Commit Message]
E --> F[Return Generated Commit Message]
F --> G[Insert Commit Message into Git Commit]
G --> H[Finalize Commit]
```

---

## Commands

This tool accepts an argument as the command to execute. Here is a list of available commands:
Expand All @@ -78,3 +95,4 @@ This tool accepts an argument as the command to execute. Here is a list of avail
| `set-settings` | Set the OpenAI settings. |
| `help` | Display information about this program. |
| `version` | Display version information. |
```

0 comments on commit 58ade13

Please sign in to comment.