From 9f615b0750c4528c0975f4db5a8615aafaf3ab2a Mon Sep 17 00:00:00 2001 From: Andrew Date: Tue, 17 Jan 2023 02:21:55 -0600 Subject: [PATCH] doc updates --- README.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1bcf5ef..4763daf 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,25 @@ This app is in development, and is currently not stable. Expect core functionality to possiblly break. -To install: `go install git.andrewnw.xyz/CyberShell/backy` +## Installing -If you leave the config path blank, the following paths will be searched in order: - - `./backy.yaml` - - `~/.config/backy.yaml` +To install: + +`go install git.andrewnw.xyz/CyberShell/backy` + +This assumes you already have a working Go environment, if not please see [this page](https://golang.org/doc/install) first. + +To run a config: + +`backy backup` + +Or to use a specific file: +```backy backup -c /path/to/file``` + +If you leave the config path blank, the following paths will be searched in order: + +- `./backy.yaml` +- `~/.config/backy.yaml` Create a file at `~/.config/backy.yaml`: @@ -83,10 +97,4 @@ notifications: ``` -To run a config: -```backy backup ``` - -Or to use a specific file: -```backy backup -c /path/to/file``` - -Note, let me know if a path lookup fails due to using Go's STDLib `os` \ No newline at end of file +Note, let me know if a path lookup fails due to using Go's STDLib `os`