From a79fba13e1e1d2da0b2b72e632ad0a4ee5f4c0e8 Mon Sep 17 00:00:00 2001 From: Alexander Neumann Date: Fri, 13 Nov 2015 12:41:36 +0100 Subject: [PATCH 1/2] Shorten README, remove options --- README.md | 26 +++----------------------- 1 file changed, 3 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index afe7cf434..9b172cb95 100644 --- a/README.md +++ b/README.md @@ -47,30 +47,10 @@ afterwards you'll find the binary in the current directory: $ ./restic --help Usage: restic [OPTIONS] + [...] - Application Options: - -r, --repo= Repository directory to backup to/restore from - - 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) +More documentation can be found on the [website](https://restic.github.io), +especially in the [user manual](https://restic.github.io/manual). Compatibility ============= From 88b167cc10c78d7e25703929def3a6a61887d13b Mon Sep 17 00:00:00 2001 From: Alexander Neumann Date: Fri, 13 Nov 2015 12:41:47 +0100 Subject: [PATCH 2/2] Add note about unreleased code in the master branch --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b172cb95..8ada2c339 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,8 @@ Backward compatibility for backups is important so that our users are always able to restore saved data. Therefore restic follows [Semantic Versioning](http://semver.org) to clearly define which versions are compatible. 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; as long as we do not increment the major version, data can be read and restored.