From 97913ffdd0d577b45aa10e7bac4913ab59f192ca Mon Sep 17 00:00:00 2001 From: Rob Bos Date: Thu, 8 Dec 2022 16:56:20 +0100 Subject: [PATCH] Make the badge text easier to copy (#1026) * Fix the spaces in the URL Signed-off-by: Rob Bos * Correct the texts Signed-off-by: Rob Bos Signed-off-by: Rob Bos --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0a537637..875e5189 100644 --- a/README.md +++ b/README.md @@ -128,12 +128,10 @@ Starting with scorecard-action:v2, users can use a REST API to query their lates ### Scorecard Badge -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: +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. ``` -[![OpenSSF Scorecard] -(https://api.securityscorecards.dev/projects/github.com/{org}/{repo}/badge)] -(https://api.securityscorecards.dev/projects/github.com/{org}/{repo}) +[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/{owner}/{repo}/badge)](https://api.securityscorecards.dev/projects/github.com/{owner}/{repo}) ``` Once this badge is added, clicking on the badge will take users to the latest run result of Scorecard.