Skip to content

Commit

Permalink
📖 Add webviewer link (#3490)
Browse files Browse the repository at this point in the history
* Update README.md

Add link to webviewer

* Update faq.md

Update webviewer link in FAQ

* Update README.md

Typo

* Update faq.md

Linebreak
  • Loading branch information
olivekl authored Sep 19, 2023
1 parent ac13ac7 commit 5c93fe6
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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/<user_name_or_org>/<repository_name>.

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
Expand Down
3 changes: 2 additions & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<username_or_org>/<repository_name>.
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/<user_name_or_org>/<repository_name>.

You can also use the CLI to generate scores for any public repository by following these steps:

Expand Down

0 comments on commit 5c93fe6

Please sign in to comment.