diff --git a/README.md b/README.md index a26481b..08f8393 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,25 @@ -## use AI to draft commit messages +# use AI to draft commit messages aicommit injects a commit message draft written by RayAI before loading your default editor for review. -requires: jq +requires: cur, jq > aicommit_groq is broken. Don't use. -### use +## use -Change your +1. Clone the repo + +1. Add to your `~/.bashrc` ```bash export GIT_EDITOR="aicommit" ``` +1. Use git as normal. + ```bash git commit ``` + +Using the `-m` flag will bypass generating a message `git commit -m` diff --git a/test.txt b/test.txt new file mode 100644 index 0000000..484ba93 --- /dev/null +++ b/test.txt @@ -0,0 +1 @@ +This is a test.