diff --git a/README.md b/README.md index 78b3b4a..980fc4b 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,7 @@ Have AI Commit write your git commit messages for you so you never have to write ## How to install -1. Run `npm i -g zx` (this CLI uses zx) -2. Run `git clone github.com/nutlope/aicommit` in your root directory -3. Add a file called `.env.json` in the folder with your OpenAI API key. You can get this by [signing up](https://openai.com/api/) -4. [Optional] If you're on mac, add `alias aicommit="zx ~/ai-commit/aicommit.mjs"` to your `.zshrc` so you can trigger the program simply by typing `aicommit` +`npm install -g autocommit` **Note:** The process to install this will get vastly simplified when I rewrite this CLI and publish it as an npm package to be run with `npx`. @@ -35,5 +32,3 @@ After: - [ ] Build landing page # How to run new version - -`npm install -g zx aicommit` diff --git a/package-lock.json b/package-lock.json deleted file mode 100644 index f6283a1..0000000 --- a/package-lock.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "name": "ai-commit", - "version": "1.0.0", - "lockfileVersion": 2, - "requires": true, - "packages": { - "": { - "name": "ai-commit", - "version": "1.0.0", - "hasInstallScript": true, - "license": "ISC" - } - } -} diff --git a/package.json b/package.json index e495086..ec66b4f 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,15 @@ { - "name": "commitai", - "version": "0.0.1", + "name": "autocommit", + "version": "0.0.3", "description": "generates ai commit", "main": "aicommit.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "start": "./aicommit.js" }, + "bin": { + "gpt-commit": "./aicommit.js" + }, "repository": { "type": "git", "url": "git+https://github.com/Nutlope/ai-commit.git"