Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📖 Add webviewer link #3490

Merged
merged 4 commits into from
Sep 19, 2023
Merged

📖 Add webviewer link #3490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
18c5f90
Update README.md
olivekl Sep 19, 2023
c4358e1
Update faq.md
olivekl Sep 19, 2023
2a4834d
Update README.md
olivekl Sep 19, 2023
39b9e53
Update faq.md
olivekl Sep 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading