Updated readme
parent
a94d0221c5
commit
5a403b4b64
25
README.md
25
README.md
|
@ -6,7 +6,7 @@ webhooks. Backups are compressed and stored as `tar.gz` archives.
|
||||||
|
|
||||||
## Help
|
## Help
|
||||||
```
|
```
|
||||||
albatross 0.2.0
|
albatross 0.3.0
|
||||||
Backup your Minecraft Server!
|
Backup your Minecraft Server!
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
|
@ -20,14 +20,25 @@ OPTIONS:
|
||||||
-c, --config-path <config-path> Path to the Albatross config [env: ALBATROSS_CONFIG=]
|
-c, --config-path <config-path> Path to the Albatross config [env: ALBATROSS_CONFIG=]
|
||||||
|
|
||||||
SUBCOMMANDS:
|
SUBCOMMANDS:
|
||||||
backup Backup a server
|
backup Backup a server
|
||||||
export Export a backup as a single player world
|
export Export a backup as a single player world
|
||||||
help Prints this message or the help of the given subcommand(s)
|
help Prints this message or the help of the given subcommand(s)
|
||||||
|
restore Restore certain chunks from a backup
|
||||||
Process finished with exit code 1
|
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 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
|
## Config
|
||||||
```toml
|
```toml
|
||||||
[backup]
|
[backup]
|
||||||
|
|
Loading…
Reference in New Issue