Commits

Seth Jackson  committed ce5442f

Add config file docs to the README.

  • Participants
  • Parent commits ddfcd82

Comments (0)

Files changed (1)

     $ gem install bitbucket-backup
 
 
-## Basic Usage
+## Usage
 
     $ bitbucket-backup [options] /path/to/backupdir
-    
-        -a, --all-repos                  Backup all visible repos to user
-        -u, --username USERNAME          Username for account to be backed up
+
+See the help prompt for more info:
+
+    $ bitbucket-backup -h
+
+
+## Config files
+
+You can provide a config file in the YAML format
+to `bitbucket-backup` via the `--config` or `-c` option.
+Settings specified on the command line have precedence
+over settings in the config file.
+
+The `username`, `password` and `all_repos` settings will be
+read from the config file.
+
+For example to backup every repo the user `example` has access to
+put the following in a config file and pass it to `bitbucket-backup`:
+
+    username: example
+    password: example
+    all_repos: true
 
 
 ## License