* feat(README.md): add OpenCommit example image to README

* chore(README.md): update OPENAI_API_KEY config key to use 'your_api_key' instead of 'your token'
* chore(README.md): update description of where the api key is stored
This commit is contained in:
di-sukharev
2023-03-10 15:59:57 +08:00
parent 5abe5d715d
commit e4de6d8186
2 changed files with 5 additions and 3 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 318 KiB

+5 -3
View File
@@ -11,7 +11,9 @@
---
## Examples
<div align="center">
<img src=".github/opencommit-example.png" alt="OpenCommit example"/>
</div>
All the commits in this repo are done with OpenCommit — look into [the commits](https://github.com/di-sukharev/opencommit/commit/eae7618d575ee8d2e9fff5de56da79d40c4bc5fc) to see how OpenCommit works. Emoji and long commit description text is configurable.
@@ -30,10 +32,10 @@ All the commits in this repo are done with OpenCommit — look into [the commits
3. Set the key to opencommit config:
```sh
opencommit config set OPENAI_API_KEY=<your token>
opencommit config set OPENAI_API_KEY=<your_api_key>
```
Your token isn't sent to anyone, it's saved in `~/.opencommit` config file.
Your api key is stored locally in `~/.opencommit` config file.
## Usage