diff --git a/README.md b/README.md index 487577d..f110101 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ -# goblin-store +# Goblin Store -Incremental backup tool using rclone \ No newline at end of file +Incremental backup tool using rclone. + +## Usage + +To backup a directory, simply run it like so: + +```shell +./goblin-store backup -s -d +``` + +Breaking down the above: + +* `./goblin-store` - running the app binary +* `backup` - call the **backup** command +* `-s ` - the directory you'd wish to backup (REQUIRED) +* `-d ` - the directory you'd wish to store the backups in (REQUIRED) + +You may modify the behavior with these additional flags: + +* `-w ` - the number of worker threads to use to backup (default is **4**) +* `-v` - enable verbose console logging + +## License + +This project is available under the BSD 3-Clause license.