diff --git a/.github/opencommit-example.png b/.github/opencommit-example.png new file mode 100644 index 0000000..4ee4c40 Binary files /dev/null and b/.github/opencommit-example.png differ diff --git a/README.md b/README.md index 7711fd7..648f802 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,9 @@ --- -## Examples +
+ OpenCommit example +
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= + opencommit config set OPENAI_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