Skip to content

Commit

Permalink
docs: add installation instructions for mac and linux
Browse files Browse the repository at this point in the history
  • Loading branch information
JamieMagee authored Dec 8, 2021
1 parent 75bcc33 commit e1689b2
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,29 @@ Language: You must have GoLang installed to run Scorecards (https://golang.org/d

### Installation

To install Scorecards:
#### Standalone

To install Scorecards as a standalone:

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)

#### Using Homebrew

You can use [Homebrew](https://brew.sh/) (on macOS or Linux) to install Scorecards.

```sh
brew install scorecard
```

### Using Linux package managers

| Package Manager | Linux Distribution | Command |
|------------------------------------------------------------|--------------------|--------------------------------------------|
| Nix | NixOS | `nix-env -iA nixpkgs.scorecard` |
| [AUR helper](https://wiki.archlinux.org/title/AUR_helpers) | Arch Linux | Use your AUR helper to install `scorecard` |

### Authentication

Before running Scorecard, you need to either:
Expand Down

0 comments on commit e1689b2

Please sign in to comment.