Add readme

Author: nodkz

README.md

@@ -1,21 +1,73 @@
 graphql-compose-connection
 ======================
-This is a plugin for [graphql-compose](https://github.com/nodkz/graphql-compose), which adds to the GraphQL types `connection` resolvers.
+This is a plugin for [graphql-compose](https://github.com/nodkz/graphql-compose) family, which adds to the GraphQL types `connection` resolvers.
+
+This package completely follows to Relay Cursor Connections Specification (https://facebook.github.io/relay/graphql/connections.htm).
+
+Besides standard connection arguments `first`, `last`, `before` and `after`, also added great arguments:
+* `filter` arg - for filtering records
+* `sort` arg - for sorting records. Build in mechanism allows sort by any unique indexes (not only by id). Also supported compound sorting (by several fields).
 
 [CHANGELOG](https://github.com/nodkz/graphql-compose-connection/blob/master/CHANGELOG.md)
 
 Example
 =======
+```js
+import composeWithConnection from 'graphql-compose-connection';
+import userTypeComposer from './user.js';
+const OPERATORS_FIELDNAME = '_operators';
 
+composeWithConnection(userTypeComposer, {
+  findResolverName: 'findMany',
+  countResolverName: 'count',
+  sort: {
+    _ID_DESC: {
+      uniqueFields: ['_id'],
+      sortValue: { _id: -1 },
+      directionFilter: (cursorData, filter, isBefore) => {
+        filter[OPERATORS_FIELDNAME] = filter[OPERATORS_FIELDNAME] || {};
+        filter[OPERATORS_FIELDNAME]._id = filter[OPERATORS_FIELDNAME]._id || {};
+        if (isBefore) {
+          filter[OPERATORS_FIELDNAME]._id.gt = cursorData._id;
+        } else {
+          filter[OPERATORS_FIELDNAME]._id.lt = cursorData._id;
+        }
+        return filter;
+      },
+    },
+    AGE_ID_ASC: {
+      uniqueFields: ['age', '_id'],
+      sortValue: { age: 1, _id: -1 },
+      directionFilter: (cursorData, filter, isBefore) => {
+        filter[OPERATORS_FIELDNAME] = filter[OPERATORS_FIELDNAME] || {};
+        filter[OPERATORS_FIELDNAME]._id = filter[OPERATORS_FIELDNAME]._id || {};
+        filter[OPERATORS_FIELDNAME].age = filter[OPERATORS_FIELDNAME].age || {};
+        if (isBefore) {
+          filter[OPERATORS_FIELDNAME].age.lt = cursorData.age;
+          filter[OPERATORS_FIELDNAME]._id.gt = cursorData._id;
+        } else {
+          filter[OPERATORS_FIELDNAME].age.gt = cursorData.age;
+          filter[OPERATORS_FIELDNAME]._id.lt = cursorData._id;
+        }
+        return filter;
+      },
+    }
+  },
+})
+```
+<img width="946" alt="screen shot 2016-07-14 at 15 30 24" src="https://cloud.githubusercontent.com/assets/1946920/16834977/1e0b6760-49d8-11e6-833f-cae5ffa68717.png">
 
 Requirements
 ============
+Types should have following resolvers:
+* `count` - for counting records
+* `findMany` - for filtering records. Also required that this resolver supports search with operators (lt, gt), which used in `directionFilter` option. Resolver `findMany` should have `filter` argument, which will be copied to connection.
 
-
-Compatible plugins
-==================
+Used in plugins
+===============
+[graphql-compose-mongoose](https://github.com/nodkz/graphql-compose-mongoose)
 
 
 License
 =======
-[MIT](https://github.com/nodkz/graphql-compose-relay/blob/master/LICENSE.md)
+[MIT](https://github.com/nodkz/graphql-compose-connection/blob/master/LICENSE.md)