summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index e69de29..b3a65b9 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,16 @@
+# jq.py: a lightweight and flexible JSON processor
+
+Warning: this project is not production-ready.
+There are almost certainly a number of memory leaks and the API is not stable.
+
+This project contains Python bindings for (jq)[http://stedolan.github.io/jq/].
+
+## Examples
+
+```python
+from jq import jq
+
+assert [2, 3, 4] == jq("[.[]+1]").transform_json([1, 2, 3]).json()
+assert [2,3,4] == str(jq("[.[]+1]").transform_json([1, 2, 3]))
+assert [2,3,4] == str(jq("[.[]+1]").transform_string("[1, 2, 3]"))
+```