From e1689b26151d147b1e1ba9e82f4953d4573d8c14 Mon Sep 17 00:00:00 2001 From: Jamie Magee Date: Wed, 8 Dec 2021 11:51:00 -0800 Subject: [PATCH] docs: add installation instructions for mac and linux --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e3c43e25ae3..0d890bbe305 100644 --- a/README.md +++ b/README.md @@ -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: