From a5773f28a3e470f5000de8815738b88f3ef4408f Mon Sep 17 00:00:00 2001 From: Chris Palmer Date: Fri, 27 Dec 2019 17:44:44 -0800 Subject: [PATCH] README: update the installation and build instructions (#31) Co-authored-by: Filippo Valsorda <1225294+FiloSottile@users.noreply.github.com> --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ca384b3..f66cc03 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Usage: age --decrypt [-i KEY] [-o OUTPUT] [INPUT] Options: - -o OUTPUT Write the result to the file at path OUTPUT. + -o, --output OUTPUT Write the result to the file at path OUTPUT. -a, --armor Encrypt to a PEM encoded format. -p, --passphrase Encrypt with a passphrase. -r, --recipient RECIPIENT Encrypt to the specified RECIPIENT. Can be repeated. @@ -40,18 +40,20 @@ Multiple keys can be provided, and any unused ones will be ignored. ## Installation -On macOS, use Homebrew. +On macOS, you can use Homebrew: ``` brew tap filippo.io/age https://filippo.io/age brew install age ``` -On Linux and Windows, use [the pre-built binaries](https://github.com/FiloSottile/age/releases) or build from source with Go 1.13+. +On Windows, Linux, and macOS, you can use [the pre-built binaries](https://github.com/FiloSottile/age/releases). + +If your system has [Go 1.13+](https://golang.org/dl/), you can build from source: ``` git clone https://filippo.io/age && cd age -go build filippo.io/cmd/age/... +go build filippo.io/age/cmd/... ``` Help from new packagers is very welcome.