Update README.markdown

Document new arguments
This commit is contained in:
Chris Lockfort 2013-08-01 17:03:16 -07:00
parent 0a6211f4d0
commit 11c003c6af

View file

@ -21,7 +21,24 @@ Installation is simple with
Usage
-----
./github-backup.py USERNAME BACKUPDIR [-c|--cron] [-h|--help]
````
usage: github-backup.py [-h] [-c] [-m] [-g ARGS] [-s SUFFIX]
username backupdir
makes a backup of all of a github user's repositories
positional arguments:
username A Github username
backupdir The folder where you want your backups to go
optional arguments:
-h, --help show this help message and exit
-c, --cron Use this when running from a cron job
-m, --mirror Create a bare mirror
-g ARGS, --git ARGS Pass extra arguments to git
-s SUFFIX, --suffix SUFFIX
Add suffix to repository directory names
````
Then, put it in a cron job somewhere and forget about it for eternity.