From 9eae39e2faf8ed79720be2b358e0d341b4cb9a3c Mon Sep 17 00:00:00 2001 From: Ben Johnson Date: Thu, 21 Jan 2021 15:01:30 -0700 Subject: [PATCH] README --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6a47ee1..53753b1 100644 --- a/README.md +++ b/README.md @@ -10,17 +10,16 @@ background process and safely replicates changes incrementally to another file or S3. Litestream only communicates with SQLite through the SQLite API so it will not corrupt your database. +If you need support or have ideas for improving Litestream, please visit the +[GitHub Discussions](https://github.com/benbjohnson/litestream/discussions) to +chat. + If you find this project interesting, please consider starring the project on GitHub. ## Installation -### Homebrew - -TODO - - ### Linux (Debian) You can download the `.deb` file from the [Releases page][releases] page and @@ -44,6 +43,17 @@ You can also download the release binary for your system from the [Releases page][releases] and run it as a standalone application. +### Building from source + +First, download and install the [Go toolchain](https://golang.org/). Then run: + +```sh +$ go install ./cmd/litestream +``` + +The `litestream` binary should be in your `$GOPATH/bin` folder. + + ## Configuration Once installed locally, you'll need to create a config file. By default, the