From 69da704b133ecb41f0db834c3c16eeb9fb0f80d9 Mon Sep 17 00:00:00 2001 From: olivekl <83081275+olivekl@users.noreply.github.com> Date: Tue, 19 Sep 2023 16:10:06 -0400 Subject: [PATCH 1/2] Update README.md Signed-off-by: olivekl --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0c82438a18a..e3a1af9ca40 100644 --- a/README.md +++ b/README.md @@ -94,10 +94,12 @@ metrics. Prominent projects that use Scorecard include: ### 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//. +To see scores for projects regually scanned by Scorecard, navigate to the webviewer, replacing the placeholder text with the platform, user/org, and repository name: +https://securityscorecards.dev/viewer/?uri=.com//. -For example: [https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard](https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard). +For example: + - [https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard](https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard) + - [https://securityscorecards.dev/viewer/?uri=gitlab.com/fdroid/fdroidclient](https://securityscorecards.dev/viewer/?uri=gitlab.com/fdroid/fdroidclient) To view scores for projects not included in the webviewer, use the [Scorecard CLI](#scorecard-command-line-interface). From 64b74aadb473173c61f7e2c07b1ea278c3b040e0 Mon Sep 17 00:00:00 2001 From: olivekl <83081275+olivekl@users.noreply.github.com> Date: Tue, 19 Sep 2023 16:13:39 -0400 Subject: [PATCH 2/2] Update faq.md Signed-off-by: olivekl --- docs/faq.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 262b80f62b6..2ae17986580 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -25,8 +25,11 @@ This page answers frequently asked questions about Scorecard, including its purp Yes. -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//. +Over a million projects are automatically tracked by the Scorecard project. Use the webviewer to see these scores, replacing the placeholder text with the platform, user/org, and repository name: https://securityscorecards.dev/viewer/?uri=.com//. + +For example: + - [https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard](https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard) + - [https://securityscorecards.dev/viewer/?uri=gitlab.com/fdroid/fdroidclient](https://securityscorecards.dev/viewer/?uri=gitlab.com/fdroid/fdroidclient) You can also use the CLI to generate scores for any public repository by following these steps: