diff --git a/README.md b/README.md index e91e1fb..01bcd33 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,58 @@ # backuper - + +## Usage + +### Incremental backup + +```sh +backuper i +``` + +### Full backup + +```sh +backuper f +``` + +### Search files in backup + +```sh +backuper s +``` + +### Recover files from backup + +```sh +backuper r +``` + +Examples: + +```sh +# Recover Go files relevant as of 01.01.2023 to /home/user/go directory +backuper r config.conf "*.go" "01.01.2023" "/home/user/go" +``` + +### Test backup for errors + +```sh +backuper t +``` + +## Basic config example + +Backup config files from `/etc` and sqlite files from `/var`: + +```toml +FileName = "backup" + +[[Patterns]] +Path = "/etc" +FileNamePatternList = ["*.conf", "*.toml", "*.ini", "*.yaml"] +Recursive = true + +[[Patterns]] +Path = "/var" +FileNamePatternList = ["*.sqlite"] +Recursive = true +```