From 16f5087d68453776bc0eab9634f82d584bd891a2 Mon Sep 17 00:00:00 2001 From: Diogo Teles Sant'Anna Date: Sun, 16 Jul 2023 13:27:55 -0300 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20=20Suggest=20new=20score=20viewe?= =?UTF-8?q?r=20on=20badge=20documentation=20(#3268)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs(readme): suggest new score viewer on badge documentation Signed-off-by: Diogo Teles Sant'Anna * docs(readme): add link to ossf blogpost about the badge Signed-off-by: Diogo Teles Sant'Anna * docs: update badge of our own README to the new viewer Signed-off-by: Diogo Teles Sant'Anna --------- Signed-off-by: Diogo Teles Sant'Anna Signed-off-by: Allen Shearin --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0201b8fbc00..f5e59c76d34 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # OpenSSF Scorecard -[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/ossf/scorecard/badge)](https://api.securityscorecards.dev/projects/github.com/ossf/scorecard) +[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/ossf/scorecard/badge)](https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard) [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/5621/badge)](https://bestpractices.coreinfrastructure.org/projects/5621) ![build](https://github.com/ossf/scorecard/workflows/build/badge.svg?branch=main) ![CodeQL](https://github.com/ossf/scorecard/workflows/CodeQL/badge.svg?branch=main) @@ -154,12 +154,12 @@ in the Scorecard GitHub Action setting. Enabling [`publish_results: true`](https://github.com/ossf/scorecard-action/blob/dd5015aaf9688596b0e6d11e7f24fff566aa366b/action.yaml#L35) in Scorecard GitHub Actions also allows maintainers to display a Scorecard badge on their repository to show off their -hard work. This badge also auto-updates for every change made to the repository. +hard work. This badge also auto-updates for every change made to the repository. See more details on [this OSSF blogpost](https://openssf.org/blog/2022/09/08/show-off-your-security-score-announcing-scorecards-badges/). + To include a badge on your project's repository, simply add the following markdown to your README: ``` -[![OpenSSF -Scorecard](https://api.securityscorecards.dev/projects/github.com/{owner}/{repo}/badge)](https://api.securityscorecards.dev/projects/github.com/{owner}/{repo}) +[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/{owner}/{repo}/badge)](https://securityscorecards.dev/viewer/?uri=github.com/{owner}/{repo}) ``` ### Scorecard Command Line Interface