From 3c7470f58c4371d8ac58beaeeacf771227d63ce8 Mon Sep 17 00:00:00 2001 From: Spencer Schrock Date: Thu, 22 Jun 2023 18:11:36 -0700 Subject: [PATCH] :book: Update README badge link to use new uri param. (#1185) Signed-off-by: Spencer Schrock --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index be9bd95e..2367e8b0 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ Starting with scorecard-action:v2, users can use a REST API to query their lates 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/{owner}/{repo}/badge)](https://securityscorecards.dev/viewer/?platform=github.com&org={owner}&repo={repo}) +[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/{owner}/{repo}/badge)](https://securityscorecards.dev/viewer/?uri=github.com/{owner}/{repo}) ``` Once this badge is added, clicking on the badge will take users to the latest run result of Scorecard.