diff --git a/README.md b/README.md index 0585b9b55..769de66ac 100644 --- a/README.md +++ b/README.md @@ -43,11 +43,35 @@ Restic is a program that does backups right. The design goals are: Building ======== -Install Go/Golang (at least 1.3), then run: +Install Go/Golang (at least version 1.3), then run `make`, afterwards you'll +find the binary in the current directory: - export GOPATH=~/src/go - go get github.com/restic/restic/cmd/restic - $GOPATH/bin/restic --help + $ make + [...] + + $ ./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 + find find a file/directory + fsck check the repository + init create repository + key manage keys + list lists data + ls list files + restore restore a snapshot + snapshots show snapshots + version display version Contribute and Documentation