summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2013-06-19 11:22:00 +0100
committerMichael Williamson <mike@zwobble.org>2013-06-19 11:22:00 +0100
commita3cfb19c4448d97fc0036e2fee10506d94a88fef (patch)
tree38c7af3a00917cc1286351ccaa1d201c866b96cd
parent20a73a5f293492b9490f4fec3a060cc173c879f8 (diff)
Add README.md
-rw-r--r--README.md16
-rw-r--r--setup.py2
2 files changed, 17 insertions, 1 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]"))
+```
diff --git a/setup.py b/setup.py
index 3075d2d..dd4911a 100644
--- a/setup.py
+++ b/setup.py
@@ -53,7 +53,7 @@ jq_extension = Extension(
setup(
name='jq',
version='0.1.0',
- description='jq is a lightweight and flexible command-line JSON processor.',
+ description='jq is a lightweight and flexible JSON processor.',
long_description=read("README"),
author='Michael Williamson',
url='http://github.com/mwilliamson/jq.py',