diff --git a/README.md b/README.md index b90d7030..9dbf9aa4 100644 --- a/README.md +++ b/README.md @@ -44,12 +44,19 @@ Built with Go, Backrest is distributed as a standalone, lightweight binary with ## Preview

- - + + +

--- +# User Guide + +[See the Backrest docs](https://garethgeorge.github.io/backrest/introduction/getting-started). + +--- + # Installation Backrest is packaged as a single executable. It can be run directly on Linux, macOS, and Windows. [restic](https://github.com/restic/restic) will be downloaded and installed on first run. @@ -72,7 +79,7 @@ Once installed, access Backrest at `http://localhost:9898` (default port). First ### Running with Docker Compose Docker image: `ghcr.io/garethgeorge/backrest` - +oplog Example compose file: ```yaml @@ -235,13 +242,6 @@ Download the Windows installer for your architecture from the [releases page](ht | `BACKREST_RESTIC_COMMAND` | Path to restic binary | Defaults to a Backrest managed version of restic in `C:\Program Files\restic\restic-x.x.x` | | `XDG_CACHE_HOME` | Path to the cache directory | | ---- - -# User Guide - -[See the Backrest docs](https://garethgeorge.github.io/backrest/introduction/getting-started). - ---- # Development