Skip to content

Commit 0429b92

Browse files
committed
chore(README.md): update title to better reflect the purpose of the project
docs(README.md): update GitHub Action setup instructions with correct link to the Marketplace and version number of the action used
1 parent e2eb13a commit 0429b92

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<h4 align="center">Follow the bird <a href="https://twitter.com/io_Y_oi"><img src="https://img.shields.io/twitter/follow/io_Y_oi?style=flat&label=io_Y_oi&logo=twitter&color=0bf&logoColor=fff" align="center"></a>
66
</h4>
77
</div>
8-
<h2>GPT CLI to auto-generate impressive commits in 1 second</h2>
8+
<h2>Auto-generate meaningful commits in 1 second</h2>
99
<p>Killing lame commits with AI 🤯🔫</p>
1010
<a href="https://www.npmjs.com/package/opencommit"><img src="https://img.shields.io/npm/v/opencommit" alt="Current version"></a>
1111
</div>
@@ -18,15 +18,15 @@
1818

1919
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.
2020

21-
## Setup OpenCommit as a Github Action
21+
## Setup OpenCommit as a Github Action 🔥
2222

2323
OpenCommit is now available as a GitHub Action which automatically improves all new commits messages when you push to remote!
2424

2525
This is great if you want to make sure all of the commits in all of repository branches are meaningful and not lame like `fix1` or `done2`.
2626

2727
### Automatic 1 click setup
2828

29-
You can simply [setup the action automatically via the GitHub Marketplace](TODO).
29+
You can simply [setup the action automatically via the GitHub Marketplace](https://github.com/marketplace/actions/opencommit-improve-commits-with-ai).
3030

3131
### Manual 3 clicks setup
3232

@@ -54,7 +54,7 @@ jobs:
5454
- uses: actions/checkout@v3
5555
with:
5656
fetch-depth: 0
57-
- uses: di-sukharev/opencommit@github-action
57+
- uses: di-sukharev/opencommit@github-action-v1
5858
with:
5959
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
6060

0 commit comments

Comments
 (0)