diff --git a/README.md b/README.md index 55fcddb..9c7a987 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ AI Commits

AI Commits

-

A CLI that writes your git commit messages for you. Never write a commit message again.

+

A CLI that writes your git commit messages for you with AI. Never write a commit message again.

Current version Hassan Twitter follower count @@ -17,15 +17,15 @@ Install the CLI then grab your [OpenAI key](https://openai.com/api/) and add it as an env variable with the two commands below. 1. `npm install -g aicommits` -2. `export OPENAI_KEY=sk-xxxxxxxxxxxxxxxx` +2. `export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxx` After that, generate your commit running `aicommits`. -> Note: If you get a EACCESS error on mac/linux when running the first command, try running it with `sudo npm install -g aicommits` and putting in your password. +> Note: If you get a EACCESS error on mac/linux when running the first command, try running it with `sudo npm install -g aicommits`. ## 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. 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. +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 GPT-3 generations aren't free. 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. @@ -34,7 +34,7 @@ Video coming soon where I rebuild it from scratch to show you how to easily buil - Only supports git diffs of up to 200 lines of code for now - Does not support conventional commits -The next version of the CLI, v2, will address both of these limitations! +The next version of the CLI, version 2, will address both of these limitations! ## Future tasks diff --git a/package.json b/package.json index 81187b6..a807906 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "aicommits", - "version": "0.5.0", + "version": "1.0.0", "description": "Writes your git commit messages for you with AI", "main": "bin/index.js", "bin": {