summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorStephen Dolan <mu@netsoc.tcd.ie>2012-09-18 23:40:19 +0100
committerStephen Dolan <mu@netsoc.tcd.ie>2012-09-18 23:40:19 +0100
commit3898f744dc624782ce21ef287b452183425154eb (patch)
tree966c7713e499efe38e37542372790cf961a65810 /README.md
parent305059ff9f630b7fb140ef61fab5613483a75ff0 (diff)
Add a README
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..8f7b240d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+jq
+==
+
+jq is a command-line JSON processor.
+
+If you want to learn to use jq, read the documentation at
+[https://stedolan.github.com/jq](https://stedolan.github.com/jq). This
+documentation is generated from the docs/ folder of this repository.
+
+If you want to hack on jq, feel free, but be warned that its internals
+are not well-documented at the moment. Bring a hard hat and a shovel.
+
+You can find some basic build instructions at
+[https://stedolan.github.com/jq/download](https://stedolan.github.com/jq/download)