From ac655c8780673635889fd0872222b32f1785ada6 Mon Sep 17 00:00:00 2001 From: gilbertchen Date: Fri, 7 Jul 2017 14:57:40 -0400 Subject: [PATCH] Update README.md --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8365b6f..23046a3 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ The [design document](https://github.com/gilbertchen/duplicacy-cli/blob/master/D ## Getting Started +
Installation Duplicacy is written in Go. You can run the following command to build the executable (which will be created under `$GOPATH/bin`): ``` @@ -36,6 +37,10 @@ go get -u github.com/gilbertchen/duplicacy/... You can also visit the [releases page](https://github.com/gilbertchen/duplicacy-cli/releases/latest) to download the pre-built binary suitable for your platform.. +
+ +
Commands + Once you have the Duplicacy executable on your path, you can change to the directory that you want to back up (called *repository*) and run the *init* command: ``` @@ -57,10 +62,9 @@ $ duplicacy restore -r 1 ``` -
- + Duplicacy provides a set of commands, such as list, check, diff, cat history, to manage snapshots: - + ```makefile $ duplicacy list # List all snapshots @@ -109,6 +113,7 @@ $ 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.