Skip to content

Commit e4de6d8

Browse files
committedMar 10, 2023
* 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
1 parent 5abe5d7 commit e4de6d8

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed
 

‎.github/opencommit-example.png

318 KB
Loading

‎README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@
1111

1212
---
1313

14-
## Examples
14+
<div align="center">
15+
<img src=".github/opencommit-example.png" alt="OpenCommit example"/>
16+
</div>
1517

1618
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.
1719

@@ -30,10 +32,10 @@ All the commits in this repo are done with OpenCommit — look into [the commits
3032
3. Set the key to opencommit config:
3133

3234
```sh
33-
opencommit config set OPENAI_API_KEY=<your token>
35+
opencommit config set OPENAI_API_KEY=<your_api_key>
3436
```
3537

36-
Your token isn't sent to anyone, it's saved in `~/.opencommit` config file.
38+
Your api key is stored locally in `~/.opencommit` config file.
3739

3840
## Usage
3941

0 commit comments

Comments
 (0)
Failed to load comments.