From c51929286964b915477ee46409f9134c17748db1 Mon Sep 17 00:00:00 2001 From: Christian Rocha Date: Tue, 7 Dec 2021 15:46:06 -0500 Subject: [PATCH] Add package manager and download info to installation notes --- README.md | 24 ++++++++++++++++++++---- DOCKER.md => docker.md | 0 2 files changed, 20 insertions(+), 4 deletions(-) rename DOCKER.md => docker.md (100%) diff --git a/README.md b/README.md index 8511b77fa..ad79d09c6 100644 --- a/README.md +++ b/README.md @@ -26,10 +26,24 @@ A tasty, self-hosted Git server for the command line. 🍦 Just run `ssh git.charm.sh` for an example. -## Building/installing +## Installation -The Soft Serve command is called `soft`. You can build and install it with -`go`: +Soft Serve is a single binary called `soft`. You can get it from a package +manager: + +```bash +# macOS or Linux +brew tap charmbracelet/tap && brew install charmbracelet/tap/soft-serve + +# Arch Linux +yay -S soft-serve +``` + +You can also download a binary from the [releases][releases] page. Packages are +available in Alpine, Debian, and RPM formats. Binaries are available for Linux, +macOS, and Windows. + +Or just build and install it with `go`: ```bash git clone ssh://git.charm.sh/soft-serve @@ -41,7 +55,9 @@ go install Make sure `git` is installed, then run `soft`. That’s it. -A [Docker image](https://github.com/charmbracelet/soft-serve/blob/main/DOCKER.md) is also available. +A [Docker image][docker] is also available. + +[docker]: https://github.com/charmbracelet/soft-serve/blob/main/docker.md ## Configuration diff --git a/DOCKER.md b/docker.md similarity index 100% rename from DOCKER.md rename to docker.md