update README and repository

README.md

@@ -2,3 +2,82 @@ GraphQLite
 =======
 
 GraphQLite is an experimental implementation of Facebook's GraphQL.
+
+## Installation
+
+```sh
+$ npm install graphqlite
+```
+
+## Usage
+
+GraphQLite exposes a simple API for parsing GraphQL (uses ES6 multi-line strings).
+
+```javascript
+var graphqlite = require('graphqlite')
+
+var output = graphqlite.parse(`
+  node(123) {
+    id,
+    name,
+    birthdate {
+      month,
+      day,
+    },
+    friends.first(1) {
+      cursor,
+      node {
+        name
+      }
+    }
+  }
+`)
+```
+
+In the above example, `output` will be:
+
+```javascript
+[
+  {
+    calls: [{ type: 'node', param: 123 }],
+    fields: {
+      id: true,
+      name: true,
+      birthdate: {
+        calls: [],
+        fields: {
+          month: true,
+          day: true
+        }
+      },
+      friends: {
+        calls: [ { type: 'first', param: 1 }],
+        fields: {
+          cursor: true,
+          node: {
+            calls: [],
+            fields: {
+              name: true
+            }
+          }
+        }
+      }
+    }
+  }
+]
+```
+
+## Roadmap
+Facebook will be releasing a GraphQL module in the future, but I didn't know what to expect from this
+so I created this basic one as an experiment.
+Therefore this module could become obselete in the future.
+
+I do plan on adding some additional features though:
+- GraphQL generation from object
+- Other ideas welcome
+
+## License
+
+Licensed under the MIT License.
+
+View the full license [here](https://raw.githubusercontent.com/madjam002/graphqlite/master/LICENSE).

package.json

@@ -15,11 +15,13 @@
     "graphql",
     "react"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/madjam002/graphqlite.git"
+  },
   "author": "Jamie Greeff <[email protected]>",
   "license": "MIT",
-  "dependencies": {
-    "pegjs": "^0.8.0"
-  },
+  "dependencies": {},
   "devDependencies": {
     "babel-jest": "^4.0.0",
     "jest-cli": "^0.4.0"