From 9ffa2e473e1cd59010b900a4fa523d16b31868d1 Mon Sep 17 00:00:00 2001 From: Andrew Date: Sun, 19 Feb 2023 22:13:43 -0600 Subject: [PATCH] update readme [CI SKIP] --- README.md | 31 ++++--------------------------- 1 file changed, 4 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 2675356..3e174b7 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,11 @@ -# Backy - an application to manage backups - -This app is in development, and is currently not stable. Expect core functionality to possiblly break. - -## Installing -To install: +# Backy - an application to manage backups -`go install git.andrewnw.xyz/CyberShell/backy@master` +See the [install documentation](https://backy.cybershell.xyz/getting-started/install/index.html) -This assumes you already have a working Go environment, if not please see [this page](https://golang.org/doc/install) first. +## Security -You can also download binaries [here](https://git.andrewnw.xyz/CyberShell/backy/releases) and [here](https://github.com/CybersShell/backy/releases). +The latest version is currently the only supported version. ## Features @@ -25,21 +20,3 @@ You can also download binaries [here](https://git.andrewnw.xyz/CyberShell/backy/ - Run in cron mode - For any command, especially backup commands - -To run a config: - -`backy backup` - -Or to use a specific file: -```backy backup -f /path/to/file``` - -If you leave the config path blank, the following paths will be searched in order: - -- `./backy.yml` -- `./backy.yaml` -- `~/.config/backy.yml` -- `~/.config/backy.yaml` - -Create a file at `~/.config/backy.yml`. - -See the config file in the examples directory to configure it.