doc updates
This commit is contained in:
parent
8e9d563d1f
commit
9f615b0750
22
README.md
22
README.md
@ -2,9 +2,23 @@
|
||||
|
||||
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
|
||||
|
||||
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`
|
||||
|
||||
@ -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`
|
Loading…
Reference in New Issue
Block a user