From 4df3d6409966b02584528f759e1abd5a14756d43 Mon Sep 17 00:00:00 2001 From: Hassan El Mghari Date: Mon, 13 Feb 2023 20:46:40 -0500 Subject: [PATCH] updated README --- README.md | 4 +++- package.json | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 971893e..d21fb67 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,9 @@ Install the CLI then grab your [OpenAI key](https://openai.com/api/) and add it 1. `npm install -g aicommits` 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`. diff --git a/package.json b/package.json index 323e6f5..b99ce7e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "aicommits", - "version": "1.0.1", + "version": "1.0.2", "description": "Writes your git commit messages for you with AI", "main": "bin/index.js", "bin": {