Update README.md with new instructions on using aicommit

Replace outdated information about `aicommit_groq`
Clarify prerequisites for using Aicommit
Add setup and usage section to README.md
Document bypassing AI-generated commit messages using the `-m` flag
This commit is contained in:
ilguappo 2024-08-08 02:22:20 -07:00
parent e3704b4e6e
commit baed3d5d17
Signed by: ilguappo
GPG Key ID: 98486F29C8969FD0

View File

@ -1,25 +1,25 @@
# use AI to draft commit messages # **Use AI to Draft Commit Messages with Aicommit**
aicommit injects a commit message draft written by RayAI before loading your default editor for review. Aicommit integrates with RayAI to generate a draft commit message, which is then loaded into your default editor for review and editing.
requires: cur, jq ## **Prerequisites**
> aicommit_groq is broken. Don't use. To use Aicommit, you need to have the following tools installed:
## use - `curl`
- `jq`
1. Clone the repo **Note**: Aicommit-groq is currently broken and should not be used.
1. Add to your `~/.bashrc` ## **Setup and Usage**
1. **Clone the repository**: Clone the Aicommit repository to your local machine.
2. **Configure your Git editor**: Add the following line to your `~/.bashrc` file, replacing `<path/to/>` with the actual path to the Aicommit executable:
```bash ```bash
export GIT_EDITOR="<path/to/>aicommit" export GIT_EDITOR="<path/to/>aicommit"
``` ```
1. Use git as normal. 3. **Use Git as normal**: Once configured, you can use Git as you normally would. When you run `git commit`, Aicommit will generate a draft commit message using RayAI, which will then be loaded into your default editor for review and editing.
```bash **Bypassing AI-generated messages**: If you prefer to write your own commit message, you can use the `-m` flag with `git commit`, like this: `git commit -m "your message here"`. This will bypass the AI-generated message and allow you to write your own message directly.
git commit
```
Using the `-m` flag will bypass generating a message `git commit -m`