add usage

aspiers · aspiers · commit 57ef64ecec59 · 2018-06-15T10:41:04.000+01:00
diff --git a/README.rst b/README.rst
@@ -145,8 +145,24 @@ Please see `the INSTALL.rst file <INSTALL.rst>`_.
 Usage
 =====
 
-The tool is not yet documented, but usage is fairly self-explanatory
-if you run ``git explode -h``.
+Usage is fairly self-explanatory if you run ``git explode -h``::
+
+    usage: git-explode [-h] [--version] [-d] [-p PREFIX] [-c NUM] BASE HEAD
+
+    Explode linear sequence of commits into topic branches
+
+    positional arguments:
+      BASE                  base of sequence to explode
+      HEAD                  head of sequence to explode
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      --version             show program's version number and exit
+      -d, --debug           Show debugging
+      -p PREFIX, --prefix PREFIX
+                            prefix for all created topic branches
+      -c NUM, --context-lines NUM
+                            Number of lines of diff context to use [1]
 
 
 Development / support / feedback
diff --git a/git_explode/cli.py b/git_explode/cli.py
@@ -18,6 +18,9 @@ def parse_args(args):
     :param args: command line parameters as list of strings
     :return: command line parameters as :obj:`argparse.Namespace`
     """
+    #####################################################################
+    # REMINDER!!  If you change this, remember to update README.rst too.
+    #####################################################################
     parser = argparse.ArgumentParser(
         description="Explode linear sequence of commits into topic branches")
     parser.add_argument(
