summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--plugins/jsontools/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/plugins/jsontools/README.md b/plugins/jsontools/README.md
new file mode 100644
index 000000000..ed7a19d29
--- /dev/null
+++ b/plugins/jsontools/README.md
@@ -0,0 +1,17 @@
+# jsontools
+
+# Plugin name
+
+A handy command line tool for dealing with json data.
+
+## Usage
+
+```sh
+# curl json data and pretty print the results
+curl https://coderwall.com/bobwilliams.json | pp_json
+
+# pretty print the contents of an existing json file
+less data.json | pp_json
+
+# json data directly from the command line
+echo '{"b":2, "a":1}' | pp_json \ No newline at end of file