Trez/opencommit-gitea
4
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

chore(README.md): fix capitalization of OpenCommit in setup and usage sections

Browse Source 
docs(README.md): fix typo in Git hook section
This commit is contained in:
di-sukharev
2023-03-16 23:14:29 +08:00
parent 0d1f72bdec
commit c787329710
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -4
View File
@@ -20,7 +20,7 @@ All the commits in this repo are done with OpenCommit — look into [the commits
## Setup ## Setup
1. Install opencommit globally to use in any repository: 1. Install OpenCommit globally to use in any repository:
```sh ```sh
npm install -g opencommit 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. 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 ```sh
opencommit config set OPENAI_API_KEY=<your_api_key> opencommit config set OPENAI_API_KEY=<your_api_key>
@@ -38,7 +38,7 @@ All the commits in this repo are done with OpenCommit — look into [the commits
## Usage ## 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 ```sh
git add <files...> git add <files...>
@@ -86,7 +86,7 @@ oc config set description=false
## Git hook ## 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: To set the hook: