diff --git a/README.md b/README.md index b278730..b84e78c 100644 --- a/README.md +++ b/README.md @@ -5,36 +5,36 @@

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

Current version - - Hassan Twitter follower count - --- -## Installation and Usage +## Setup -1. Install the CLI: +> The minimum supported version of Node.js is the latest v14. Check your Node.js version with `node --version`. - ```sh - npm install -g aicommits - ``` + +1. Install _aicommits_: + + ```sh + npm install -g aicommits + ``` 2. Retrieve your API key from [OpenAI](https://platform.openai.com/account/api-keys) - > Note: If you haven't already, you'll have to create an account and set up billing. + > Note: If you haven't already, you'll have to create an account and set up billing. 3. Set the key so aicommits can use it: - ```sh - aicommits config set OPENAI_KEY= - ``` + ```sh + aicommits config set OPENAI_KEY= + ``` - This will create a `.aicommitsrc` file in your home directory. + This will create a `.aicommitsrc` file in your home directory. -4. You're ready to go! +4. Start committing! - Run `aicommits` in any Git repo and it will generate a commit message for you. + Go make some changes in any Git repo, stage them, run `aicommits`, and see your AI generated message! ## How it works @@ -57,5 +57,7 @@ Video coming soon where I rebuild it from scratch to show you how to easily buil ## Maintainers -- **Hassan El Mghari**: [GitHub](https://github.com/Nutlope) | [Twitter](https://twitter.com/nutlope) -- **Hiroki Osame**: [GitHub](https://github.com/privatenumber) | [Twitter](https://twitter.com/privatenumbr) +- **Hassan El Mghari**: [@Nutlope](https://github.com/Nutlope) [Hassan Twitter follower count](https://twitter.com/nutlope) + + +- **Hiroki Osame**: [@privatenumber](https://github.com/privatenumber) [Hassan Twitter follower count](https://twitter.com/privatenumbr)