From a3cfb19c4448d97fc0036e2fee10506d94a88fef Mon Sep 17 00:00:00 2001 From: Michael Williamson Date: Wed, 19 Jun 2013 11:22:00 +0100 Subject: Add README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'README.md') 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]")) +``` -- cgit v1.2.3