README changes

This commit is contained in:
Hassan El Mghari
2023-02-13 19:48:30 -05:00
parent a6459ede07
commit 4eb240f36d
2 changed files with 4 additions and 7 deletions

View File

@@ -26,7 +26,9 @@ After that, generate your commit running `aicommits`.
## How it works ## How it works
This CLI tool runs a `git diff` command to grab all the latest changes, sends this to OpenAI's GPT-3, then returns the AI generated commit message. Video coming soon where I rebuild it from scratch to show you how to easily build your own CLI tools powered by AI. This CLI tool runs a `git diff` command to grab all the latest changes, sends this to OpenAI's GPT-3, then returns the AI generated commit message. I also want to note that it does cost money since data gets sent to OpenAI for a commit message to be generated. However, OpenAI gives folks $18 of free credits and commit message generations are cheap so it should be free for a long time.
Video coming soon where I rebuild it from scratch to show you how to easily build your own CLI tools powered by AI.
## Limitations ## Limitations
@@ -35,11 +37,6 @@ This CLI tool runs a `git diff` command to grab all the latest changes, sends th
The next version of the CLI, v2, will address both of these limitations! The next version of the CLI, v2, will address both of these limitations!
## Tasks now
- Experiment with openai curie and codex as opposed to dacinvi
- Figure out the price per commit
## Future tasks ## Future tasks
- Add support for conventional commits as a flag that users can enable - Add support for conventional commits as a flag that users can enable

View File

@@ -1,6 +1,6 @@
{ {
"name": "aicommits", "name": "aicommits",
"version": "0.3.0", "version": "0.3.2",
"description": "Writes your git commit messages for you with AI", "description": "Writes your git commit messages for you with AI",
"main": "bin/index.js", "main": "bin/index.js",
"bin": { "bin": {