CyberShell/backy
1
1
Fork 0
Code Issues 7 Pull Requests Packages Projects 1 Releases 9 Wiki Activity

doc updates

Browse Source
This commit is contained in:
Andrew 2023-01-17 02:21:55 -06:00
parent 8e9d563d1f
commit 9f615b0750
1 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -2,11 +2,25 @@
This app is in development, and is currently not stable. Expect core functionality to possiblly break. 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: To install:
- `./backy.yaml`
- `~/.config/backy.yaml` `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`: Create a file at `~/.config/backy.yaml`:
@ -83,10 +97,4 @@ notifications:
``` ```
To run a config: Note, let me know if a path lookup fails due to using Go's STDLib `os`
```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`