shiyue/aicommits
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated README

Browse Source
This commit is contained in:
Hassan El Mghari
2023-02-13 20:46:40 -05:00
parent 5bba73e4e1
commit 4df3d64099
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -19,7 +19,9 @@ Install the CLI then grab your [OpenAI key](https://openai.com/api/) and add it
1. `npm install -g aicommits` 1. `npm install -g aicommits`
2. `export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxx` 2. `export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxx`
After that, generate your commit running `aicommits`. It's recommended to add the line in #2 to your `.zshrc` or `.bashrc` so it persists instead of having to define it in each terminal session.
After doing the two steps above, generate your commit by 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`. > Note: If you get a EACCESS error on mac/linux when running the first command, try running it with `sudo npm install -g aicommits`.

2
package.json
View File

@@ -1,6 +1,6 @@
{ {
"name": "aicommits", "name": "aicommits",
"version": "1.0.1", "version": "1.0.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": {