octoleo/restic
2
2
Fork 0
mirror of https://github.com/octoleo/restic.git synced 2025-01-11 18:18:45 +00:00
Code Issues Releases Wiki Activity

Merge pull request #352 from restic/rework-readme

Browse Source 
Rework README
This commit is contained in:
Alexander Neumann 2015-11-13 23:48:17 +01:00
commit 34bf70faea
1 changed files with 5 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -47,30 +47,10 @@ afterwards you'll find the binary in the current directory:
$ ./restic --help $ ./restic --help
Usage: Usage:
restic [OPTIONS] <command> restic [OPTIONS] <command>
[...]
Application Options: More documentation can be found on the [website](https://restic.github.io),
-r, --repo= Repository directory to backup to/restore from especially in the [user manual](https://restic.github.io/manual).
Help Options:
-h, --help Show this help message
Available commands:
backup save file/directory
cache manage cache
cat dump something
check check the repository
find find a file/directory
init create repository
key manage keys
list lists data
ls list files
restore restore a snapshot
snapshots show snapshots
unlock remove locks
version display version
A short demo recording can be found here:
[![asciicast](https://asciinema.org/a/23554.png)](https://asciinema.org/a/23554)
Compatibility Compatibility
============= =============
@ -79,7 +59,8 @@ Backward compatibility for backups is important so that our users are always
able to restore saved data. Therefore restic follows [Semantic able to restore saved data. Therefore restic follows [Semantic
Versioning](http://semver.org) to clearly define which versions are compatible. Versioning](http://semver.org) to clearly define which versions are compatible.
The repository and data structures contained therein are considered the "Public The repository and data structures contained therein are considered the "Public
API" in the sense of Semantic Versioning. API" in the sense of Semantic Versioning. This goes for all released versions
of restic, this may not be the case for the master branch.
We guarantee backward compatibility of all repositories within one major version; We guarantee backward compatibility of all repositories within one major version;
as long as we do not increment the major version, data can be read and restored. as long as we do not increment the major version, data can be read and restored.