diff --git a/README.md b/README.md index 0063000..cd874ea 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ All the commits in this repo are done with OpenCommit — look into [the commits ## Setup -1. Install opencommit globally to use in any repository: +1. Install OpenCommit globally to use in any repository: ```sh npm install -g opencommit @@ -28,7 +28,7 @@ All the commits in this repo are done with OpenCommit — look into [the commits 2. Get your API key from [OpenAI](https://platform.openai.com/account/api-keys). Make sure you add payment details, so API works. -3. Set the key to opencommit config: +3. Set the key to OpenCommit config: ```sh opencommit config set OPENAI_API_KEY= @@ -38,7 +38,7 @@ All the commits in this repo are done with OpenCommit — look into [the commits ## Usage -You can call `opencommit` directly to generate a commit message for your staged changes: +You can call OpenCommit directly to generate a commit message for your staged changes: ```sh git add @@ -86,7 +86,7 @@ oc config set description=false ## Git hook -You can set opencommit as Git [`prepare-commit-msg`](https://git-scm.com/docs/githooks#_prepare_commit_msg) hook. Hook integrates with you IDE Source Control and allows you edit the message before commit. +You can set OpenCommit as Git [`prepare-commit-msg`](https://git-scm.com/docs/githooks#_prepare_commit_msg) hook. Hook integrates with you IDE Source Control and allows you edit the message before commit. To set the hook: