Skip to content

Commit b000cc7

Browse files
authored
docs: update README.md
1 parent 7102c90 commit b000cc7

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,9 @@ jobs:
8888
- Default: 'true'
8989

9090
> [!IMPORTANT]
91-
> This is a experimental feature
92-
> use it you need to set `GITHUB_TOKEN` in the GitHub Action.
91+
> This is an experimental feature. To use it you need to set `GITHUB_TOKEN` in the GitHub Action.
92+
>
93+
> This feature currently doesn’t work with forked repositories. For more details, refer to issue [#77](https://github.com/commit-check/commit-check-action/issues/77)
9394

9495
Note: the default rule of above inputs is following [this configuration](https://github.com/commit-check/commit-check/blob/main/.commit-check.yml), if you want to customize just add your `.commit-check.yml` config file under your repository root directory.
9596

@@ -117,7 +118,7 @@ By default, commit-check-action results are shown on the job summary page of the
117118

118119
## Badging your repository
119120

120-
You can add a badge to your repository to show your contributors / users that you use commit-check!
121+
You can add a badge to your repository to show your contributors/users that you use commit-check!
121122

122123
[![Commit Check](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml/badge.svg)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml)
123124

0 commit comments

Comments
 (0)