update readme [CI SKIP]

This commit is contained in:
Andrew 2023-02-19 22:13:43 -06:00
parent 9fd60b6bf7
commit 9ffa2e473e

View File

@ -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.
See the [install documentation](https://backy.cybershell.xyz/getting-started/install/index.html)
## Installing
## Security
To install:
`go install git.andrewnw.xyz/CyberShell/backy@master`
This assumes you already have a working Go environment, if not please see [this page](https://golang.org/doc/install) first.
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.