From 11c003c6af217311d9102e6a9a9340a2d8d1579d Mon Sep 17 00:00:00 2001 From: Chris Lockfort Date: Thu, 1 Aug 2013 17:03:16 -0700 Subject: [PATCH] Update README.markdown Document new arguments --- README.markdown | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 64a252e..7b056db 100644 --- a/README.markdown +++ b/README.markdown @@ -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.