Skip to content

Commit 97913ff

Browse files
authored
Make the badge text easier to copy (#1026)
* Fix the spaces in the URL Signed-off-by: Rob Bos <rajbos@users.noreply.github.com> * Correct the texts Signed-off-by: Rob Bos <rajbos@users.noreply.github.com> Signed-off-by: Rob Bos <rajbos@users.noreply.github.com>
1 parent 686440d commit 97913ff

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,12 +128,10 @@ Starting with scorecard-action:v2, users can use a REST API to query their lates
128128

129129
### Scorecard Badge
130130

131-
Starting with scorecard-action:v2, users can add a Scorecard Badge to their README to display the latest status of their Scorecard results. This requires setting [`publish_results: true`](https://github.com/ossf/scorecard/blob/d13ba3f3355b958d5d62edc47282a2e7ed9fa7c1/.github/workflows/scorecard-analysis.yml#L39) for the action and enabling [`id-token: write`](https://github.com/ossf/scorecard/blob/d13ba3f3355b958d5d62edc47282a2e7ed9fa7c1/.github/workflows/scorecard-analysis.yml#L22) permission for the job (needed to access GitHub OIDC token). The badge is updated on every run of scorecard-action and points to the latest result. To add a badge to your README, copy and paste the below lines:
131+
Starting with scorecard-action:v2, users can add a Scorecard Badge to their README to display the latest status of their Scorecard results. This requires setting [`publish_results: true`](https://github.com/ossf/scorecard/blob/d13ba3f3355b958d5d62edc47282a2e7ed9fa7c1/.github/workflows/scorecard-analysis.yml#L39) for the action and enabling [`id-token: write`](https://github.com/ossf/scorecard/blob/d13ba3f3355b958d5d62edc47282a2e7ed9fa7c1/.github/workflows/scorecard-analysis.yml#L22) permission for the job (needed to access GitHub OIDC token). The badge is updated on every run of scorecard-action and points to the latest result. To add a badge to your README, copy and paste the below line, and replace the {owner} and {repo} parts.
132132

133133
```
134-
[![OpenSSF Scorecard]
135-
(https://api.securityscorecards.dev/projects/github.com/{org}/{repo}/badge)]
136-
(https://api.securityscorecards.dev/projects/github.com/{org}/{repo})
134+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/{owner}/{repo}/badge)](https://api.securityscorecards.dev/projects/github.com/{owner}/{repo})
137135
```
138136

139137
Once this badge is added, clicking on the badge will take users to the latest run result of Scorecard.

0 commit comments

Comments
 (0)