mirror of
https://github.com/ossf/scorecard.git
synced 2024-09-17 11:57:12 +03:00
📖 docs: update website (#4041)
Signed-off-by: Raghav Kaul <raghavkaul+github@google.com>
This commit is contained in:
parent
39e968dceb
commit
39b56e809b
12
README.md
12
README.md
@ -1,6 +1,6 @@
|
||||
# OpenSSF Scorecard
|
||||
|
||||
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/ossf/scorecard/badge)](https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard)
|
||||
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/ossf/scorecard/badge)](https://scorecard.dev/viewer/?uri=github.com/ossf/scorecard)
|
||||
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/5621/badge)](https://www.bestpractices.dev/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)
|
||||
@ -100,11 +100,11 @@ metrics. Prominent projects that use Scorecard include:
|
||||
### View a Project's Score
|
||||
|
||||
To see scores for projects regularly scanned by Scorecard, navigate to the webviewer, replacing the placeholder text with the platform, user/org, and repository name:
|
||||
https://securityscorecards.dev/viewer/?uri=<github_or_gitlab>.com/<user_name_or_org>/<repository_name>.
|
||||
https://scorecard.dev/viewer/?uri=<github_or_gitlab>.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)
|
||||
- [https://securityscorecards.dev/viewer/?uri=gitlab.com/fdroid/fdroidclient](https://securityscorecards.dev/viewer/?uri=gitlab.com/fdroid/fdroidclient)
|
||||
- [https://scorecard.dev/viewer/?uri=github.com/ossf/scorecard](https://scorecard.dev/viewer/?uri=github.com/ossf/scorecard)
|
||||
- [https://scorecard.dev/viewer/?uri=gitlab.com/fdroid/fdroidclient](https://scorecard.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).
|
||||
|
||||
@ -161,7 +161,7 @@ Action
|
||||
|
||||
### Scorecard REST API
|
||||
|
||||
To query pre-calculated scores of OSS projects, use the [REST API](https://api.securityscorecards.dev).
|
||||
To query pre-calculated scores of OSS projects, use the [REST API](https://api.scorecard.dev).
|
||||
|
||||
To enable your project to be available on the REST API, set
|
||||
[`publish_results: true`](https://github.com/ossf/scorecard-action/blob/dd5015aaf9688596b0e6d11e7f24fff566aa366b/action.yaml#L35)
|
||||
@ -178,7 +178,7 @@ hard work. This badge also auto-updates for every change made to the repository.
|
||||
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://securityscorecards.dev/viewer/?uri=github.com/{owner}/{repo})
|
||||
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/{owner}/{repo}/badge)](https://scorecard.dev/viewer/?uri=github.com/{owner}/{repo})
|
||||
```
|
||||
|
||||
### Scorecard Command Line Interface
|
||||
|
@ -25,11 +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. Use the webviewer to see these scores, replacing the placeholder text with the platform, user/org, and repository name: https://securityscorecards.dev/viewer/?uri=<github_or_gitlab>.com/<user_name_or_org>/<repository_name>.
|
||||
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://scorecard.dev/viewer/?uri=<github_or_gitlab>.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)
|
||||
- [https://securityscorecards.dev/viewer/?uri=gitlab.com/fdroid/fdroidclient](https://securityscorecards.dev/viewer/?uri=gitlab.com/fdroid/fdroidclient)
|
||||
- [https://scorecard.dev/viewer/?uri=github.com/ossf/scorecard](https://scorecard.dev/viewer/?uri=github.com/ossf/scorecard)
|
||||
- [https://scorecard.dev/viewer/?uri=gitlab.com/fdroid/fdroidclient](https://scorecard.dev/viewer/?uri=gitlab.com/fdroid/fdroidclient)
|
||||
|
||||
You can also use the CLI to generate scores for any public repository by following these steps:
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user