diff --git a/README.md b/README.md index b43d91cf1a6..0c82438a18a 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ - [What Is Scorecard?](#what-is-scorecard) - [Prominent Scorecard Users](#prominent-scorecard-users) +- [View a Project's Score](#view-a-projects-score) - [Scorecard's Public Data](#public-data) ## Using Scorecard @@ -91,6 +92,15 @@ metrics. Prominent projects that use Scorecard include: - [sos.dev](https://sos.dev) - [deps.dev](https://deps.dev) +### View a Project's Score + +To see scores for the one million GitHub projects regually scanned by Scorecard, navigate to the Webviewer, replacing the placeholder text with the user/org and repository name: +https://securityscorecards.dev/viewer/?uri=github.com//. + +For example: [https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard](https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard). + +To view scores for projects not included in the webviewer, use the [Scorecard CLI](#scorecard-command-line-interface). + ### Public Data We run a weekly Scorecard scan of the 1 million most critical open source diff --git a/docs/faq.md b/docs/faq.md index 2fd5f6ffb8a..262b80f62b6 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -25,7 +25,8 @@ This page answers frequently asked questions about Scorecard, including its purp Yes. -Over a million projects are automatically tracked by the Scorecard project. These projects' scores can be seen at https://api.securityscorecards.dev/projects/github.com//. +Over a million projects are automatically tracked by the Scorecard project. View these scores with the Scorecard Webviewer, replacing the placeholder text with the user/org and repository name: +https://securityscorecards.dev/viewer/?uri=github.com//. You can also use the CLI to generate scores for any public repository by following these steps: