summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Kögl <stefan@skoegl.net>2013-10-12 12:19:41 +0200
committerStefan Kögl <stefan@skoegl.net>2013-10-12 12:19:41 +0200
commit35bf7b70619288cff7d67e279fa952c72345cc63 (patch)
tree6c040091520a25cd39532fd65edd0f23d7bea08a
parentb607526f60b5b3bc35309058c6df5ecfc710f413 (diff)
downloadpython-json-pointer-35bf7b70619288cff7d67e279fa952c72345cc63.tar.gz
add comments to commandline doc
-rw-r--r--doc/commandline.rst11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/commandline.rst b/doc/commandline.rst
index 7678442..b4a01de 100644
--- a/doc/commandline.rst
+++ b/doc/commandline.rst
@@ -20,14 +20,23 @@ The program has the following usage ::
-v, --version show program's version number and exit
-The following shows example usage ::
+Example
+^^^^^^^
+.. code-block:: bash
+
+ # inspect JSON files
$ cat a.json
{ "a": [1, 2, 3] }
+
$ cat b.json
{ "a": {"b": [1, 3, 4]}, "b": 1 }
+
+ # inspect JSON pointer
$ cat ptr.json
"/a"
+
+ # resolve JSON pointer
$ jsonpointer ptr.json a.json b.json
[1, 2, 3]
{"b": [1, 3, 4]}