From 48d3e3a25d900bf18ed1813c9caa8c792f654c44 Mon Sep 17 00:00:00 2001
From: Joe L Wroten <sharpshark28@gmail.com>
Date: Fri, 26 May 2017 06:24:25 -0500
Subject: [PATCH] Added Readme

---
 README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..02eda97
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+# json-query-chain
+
+Chain queries onto POJOs to return precise results.
+
+## Usage
+
+```javascript
+import Query from 'json-query-chain';
+
+let myQ = new Query(someJsonData)
+.search('isActiveUser', true)
+.results;
+```
+
+### Chainable Methods
+
+#### Search
+
+Currently supports booleans and strings. (See [#1](https://github.com/sharpshark28/json-query-chain/issues/1) for Integer Support)
+
+##### By Boolean
+
+```javascript
+.search('isActiveUser', true)
+```
+
+##### By String
+
+```javascript
+.search('name', 'steele')
+```
+
+#### Sort
+
+Currently supports booleans and strings. (See [#1](https://github.com/sharpshark28/json-query-chain/issues/2) for Integer Support)
+
+##### By Boolean
+
+```javascript
+.sort('isActiveUser', true)
+```
+
+##### By String
+
+```javascript
+.sort('name')
+```
+
+#### Pagination
+
+Page 1 with 5 results per page.
+
+```javascript
+.paginate(1, 5)
+```
+
+Page 2 wtih default of 10 results per page.
+
+```javascript
+.paginate(2)
+```
+
+## Tests
+
+`npm test` runs tests through Jest