From 83da36cae045c5a33ec081c1eb19f0b8f8f0fe6f Mon Sep 17 00:00:00 2001 From: gilbertchen Date: Fri, 7 Jul 2017 14:54:03 -0400 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 890fbcb..a5903af 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,7 @@ The key idea of **Lock-Free Deduplication** can be summarized as follows: The [design document](https://github.com/gilbertchen/duplicacy-cli/blob/master/DESIGN.md) explains lock-free deduplication in detail. -
## Getting Started - +## Getting Started Duplicacy is written in Go. You can run the following command to build the executable (which will be created under `$GOPATH/bin`): @@ -52,7 +51,13 @@ You can now create snapshots of the repository by invoking the *backup* command. $ duplicacy backup -stats ``` -Duplicacy provides a set of commands, such as list, check, diff, cat history, to manage snapshots: +The *restore* command rolls back the repository to a previous revision: +```sh +$ duplicacy restore -r 1 +``` + + +
```makefile $ duplicacy list # List all snapshots @@ -62,10 +67,6 @@ $ duplicacy cat # Print a file in a snapshot $ duplicacy history # Show how a file changes over time ``` -The *restore* command rolls back the repository to a previous revision: -```sh -$ duplicacy restore -r 1 -``` The *prune* command removes snapshots by revisions, or tags, or retention policies: @@ -103,10 +104,11 @@ $ duplicacy copy -r 1 -to s3 # Copy snapshot at revision 1 to the s3 storage $ duplicacy copy -to s3 # Copy every snapshot to the s3 storage ``` +
+ The [User Guide](https://github.com/gilbertchen/duplicacy-cli/blob/master/GUIDE.md) contains a complete reference to all commands and other features of Duplicacy. -
## Storages