mirror of
https://github.com/ossf/scorecard.git
synced 2024-09-17 11:57:12 +03:00
📖 Update Install command for version 3 (#1125)
* Update Install command for version 3 Change v2@latest to v@latest in README.md * Update install instruction to use GitHub releases Remove `go install` instructions and replace with instructions to download binary from GitHub releases * Update install instructions for GOPATH caps Change gopath to GOPATH
This commit is contained in:
parent
89cae3a62a
commit
da94c7c253
14
README.md
14
README.md
@ -12,7 +12,8 @@
|
||||
## Using Scorecards
|
||||
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Authentication and Setup](#authentication-and-setup)
|
||||
- [Installation](#installation)
|
||||
- [Authentication](#authentication)
|
||||
- [Basic Usage](#basic-usage)
|
||||
- [Report Problems](#report-problems)
|
||||
- [Scorecards' Public Data](#public-data)
|
||||
@ -58,7 +59,15 @@ Platforms: Currently, Scorecards supports OSX and Linux platforms. If you are us
|
||||
|
||||
Language: You must have GoLang installed to run Scorecards (https://golang.org/doc/install)
|
||||
|
||||
### Authentication and Setup
|
||||
### Installation
|
||||
|
||||
To install Scorecards:
|
||||
|
||||
1. Visit our latest [release page](https://github.com/ossf/scorecard/releases/latest) and download the correct binary for your operating system
|
||||
2. Extract the binary file
|
||||
3. Add the binary to your `GOPATH/bin` directory (use `go env GOPATH` to identify your directory if necessary)
|
||||
|
||||
### Authentication
|
||||
|
||||
Before running Scorecard, you need to either:
|
||||
|
||||
@ -109,7 +118,6 @@ docker run -e GITHUB_AUTH_TOKEN=token gcr.io/openssf/scorecard:stable --show-det
|
||||
Scorecards can run using just one argument, the URL of the target repo:
|
||||
|
||||
```shell
|
||||
$ go install github.com/ossf/scorecard/v2@latest
|
||||
$ scorecard --repo=github.com/ossf-tests/scorecard-check-branch-protection-e2e
|
||||
Starting [CII-Best-Practices]
|
||||
Starting [Fuzzing]
|
||||
|
Loading…
Reference in New Issue
Block a user