From 5b23fa6491494b53ce8d53d2ea8d0da010c2ea3f Mon Sep 17 00:00:00 2001
From: Jose Diaz-Gonzalez <myaccounts@savant.be>
Date: Mon, 8 Sep 2014 12:32:47 -0400
Subject: [PATCH] Fill out readme more

---
 README.rst | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)

diff --git a/README.rst b/README.rst
index 4ab9096..3b846ce 100644
--- a/README.rst
+++ b/README.rst
@@ -3,3 +3,63 @@ github-backup
 =============
 
 backup a github user or organization
+
+Installation
+============
+
+Using PIP via PyPI::
+
+    pip install github-backup
+
+Using PIP via Github::
+
+    pip install git+git://github.com/josegonzalez/python-github-backup.git#egg=github-backup
+
+Usage
+=====
+
+CLI Usage is as follows::
+
+    Github Backup [-h] [-u USERNAME] [-p PASSWORD] [-t TOKEN]
+                         [-o OUTPUT_DIRECTORY] [--starred] [--watched] [--all]
+                         [--issues] [--issue-comments] [--issue-events]
+                         [--repositories] [--wikis] [--skip-existing]
+                         [-L [LANGUAGES [LANGUAGES ...]]] [-N NAME_REGEX]
+                         [-R REPOSITORY] [-P] [-F] [-v]
+                         USER
+
+    Backup a github users account
+
+    positional arguments:
+      USER                  github username
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      -u USERNAME, --username USERNAME
+                            username for basic auth
+      -p PASSWORD, --password PASSWORD
+                            password for basic auth
+      -t TOKEN, --token TOKEN
+                            personal access or OAuth token
+      -o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY
+                            directory at which to backup the repositories
+      --starred             include starred repositories in backup
+      --watched             include watched repositories in backup
+      --all                 include everything in backup
+      --issues              include issues in backup
+      --issue-comments      include issue comments in backup
+      --issue-events        include issue events in backup
+      --repositories        include repository clone in backup
+      --wikis               include wiki clone in backup
+      --skip-existing       skip project if a backup directory exists
+      -L [LANGUAGES [LANGUAGES ...]], --languages [LANGUAGES [LANGUAGES ...]]
+                            only allow these languages
+      -N NAME_REGEX, --name-regex NAME_REGEX
+                            python regex to match names against
+      -R REPOSITORY, --repository REPOSITORY
+                            name of repository to limit backup to
+      -P, --private         include private repositories
+      -F, --fork            include forked repositories
+      -v, --version         show program's version number and exit
+
+The package can be used to backup an *entire* organization or repository, including issues and wikis in the most appropriate format (clones for wikis, json files for issues).