From 5a403b4b648819cc4faa19bd05d2e7d1b8f33d75 Mon Sep 17 00:00:00 2001 From: Joey Hines Date: Tue, 3 Nov 2020 21:54:15 -0600 Subject: [PATCH] Updated readme --- README.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e3fc79b..640a98e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ webhooks. Backups are compressed and stored as `tar.gz` archives. ## Help ``` -albatross 0.2.0 +albatross 0.3.0 Backup your Minecraft Server! USAGE: @@ -20,14 +20,25 @@ OPTIONS: -c, --config-path Path to the Albatross config [env: ALBATROSS_CONFIG=] SUBCOMMANDS: - backup Backup a server - export Export a backup as a single player world - help Prints this message or the help of the given subcommand(s) - -Process finished with exit code 1 - + backup Backup a server + export Export a backup as a single player world + help Prints this message or the help of the given subcommand(s) + restore Restore certain chunks from a backup ``` +## Examples +Running a backup: + +`albatorss -c test.toml backup` + +Exporting a backup to a single player world: + +`albatorss -c test.toml export backups/04-11-20_01.51.27_backup.tar.gz sp.tar.gz` + +Restoring a range of chunks (from -2,-2 to 2,2): + +`albatorss -c test.toml restore world backups/04-11-20_01.51.27_backup.tar.gz sp.tar.gz` -2 -2 2 2 + ## Config ```toml [backup]