From 02a01c6a6f99df7a4f4f9729f975a6ca4002c1a6 Mon Sep 17 00:00:00 2001 From: Mehrnoosh Beniss <49674540+mehrbeniss@users.noreply.github.com> Date: Mon, 26 Sep 2022 14:10:01 +0200 Subject: [PATCH] README: switch order of installation and usage (#448) --- README.md | 226 +++++++++++++++++++++++++++--------------------------- 1 file changed, 113 insertions(+), 113 deletions(-) diff --git a/README.md b/README.md index 1c45ea6..231c75f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

The age logo, an wireframe of St. Peters dome in Rome, with the text: age, file encryption

[![Go Reference](https://pkg.go.dev/badge/filippo.io/age.svg)](https://pkg.go.dev/filippo.io/age) -[![man page](https://img.shields.io/badge/age(1)-man%20page-lightgrey)](https://filippo.io/age/age.1) +[![man page]()](https://filippo.io/age/age.1) [![C2SP specification](https://img.shields.io/badge/%C2%A7%23-specification-blueviolet)](https://age-encryption.org/v1) age is a simple, modern and secure file encryption tool, format, and Go library. @@ -21,6 +21,118 @@ An alternative interoperable Rust implementation is available at [github.com/str The author pronounces it `[aɡe̞]`, like the Italian [“aghe”](https://translate.google.com/?sl=it&text=aghe). +## Installation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Homebrew (macOS or Linux) + brew install age +
MacPorts + port install age +
Alpine Linux v3.15+ + apk add age +
Arch Linux + pacman -S age +
Debian 11+ (Bullseye) + apt install age/bullseye-backports + (enable backports for age v1.0.0+) +
Fedora 33+ + dnf install age +
Gentoo Linux + emerge app-crypt/age +
NixOS / Nix + nix-env -i age +
openSUSE Tumbleweed + zypper install age +
Ubuntu 22.04+ + apt install age +
Void Linux + xbps-install age +
FreeBSD + pkg install age (security/age) +
OpenBSD 6.7+ + pkg_add age (security/age) +
Chocolatey (Windows) + choco install age.portable +
Scoop (Windows) + scoop bucket add extras; scoop install age +
+ +On Windows, Linux, macOS, and FreeBSD you can use the pre-built binaries. + +``` +https://dl.filippo.io/age/latest?for=linux/amd64 +https://dl.filippo.io/age/v1.0.0-rc.1?for=darwin/arm64 +... +``` + +If your system has [a supported version of Go](https://go.dev/dl/), you can build from source. + +``` +go install filippo.io/age/cmd/...@latest +``` + +Help from new packagers is very welcome. + ## Usage For the full documentation, read [the age(1) man page](https://filippo.io/age/age.1). @@ -133,115 +245,3 @@ $ curl https://github.com/benjojo.keys | age -R - example.jpg > example.jpg.age ``` Keep in mind that people might not protect SSH keys long-term, since they are revokable when used only for authentication, and that SSH keys held on YubiKeys can't be used to decrypt files. - -## Installation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Homebrew (macOS or Linux) - brew install age -
MacPorts - port install age -
Alpine Linux v3.15+ - apk add age -
Arch Linux - pacman -S age -
Debian 11+ (Bullseye) - apt install age/bullseye-backports - (enable backports for age v1.0.0+) -
Fedora 33+ - dnf install age -
Gentoo Linux - emerge app-crypt/age -
NixOS / Nix - nix-env -i age -
openSUSE Tumbleweed - zypper install age -
Ubuntu 22.04+ - apt install age -
Void Linux - xbps-install age -
FreeBSD - pkg install age (security/age) -
OpenBSD 6.7+ - pkg_add age (security/age) -
Chocolatey (Windows) - choco install age.portable -
Scoop (Windows) - scoop bucket add extras; scoop install age -
- -On Windows, Linux, macOS, and FreeBSD you can use the pre-built binaries. - -``` -https://dl.filippo.io/age/latest?for=linux/amd64 -https://dl.filippo.io/age/v1.0.0-rc.1?for=darwin/arm64 -... -``` - -If your system has [a supported version of Go](https://go.dev/dl/), you can build from source. - -``` -go install filippo.io/age/cmd/...@latest -``` - -Help from new packagers is very welcome.