More complete README

Author: fzaninotto

README.md

@@ -9,31 +9,9 @@ Get a full fake GraphQL API with zero coding in less than 30 seconds.
 
 Start playing with GraphQL right away with `json-graphql-server`, a testing and mocking tool for GraphQL. All it takes is a JSON of your data.
 
-## Usage
+## Example
 
-* CLI
-
-```sh
-npm install -g json-graphql-server
-json-graphql-server path/to/data.js
-```
-
-* Node
-
-```js
-import express from 'express';
-import { jsonGraphqlExpress } from 'json-graphql-server';
-
-const PORT = 3000;
-const app = express();
-const data = {
-    // ... your data
-};
-app.use('/graphql', jsonGraphqlExpress(data));
-app.listen(PORT);
-```
-
-## Example Data File
+Create a `db.json` file.
 
 Your data file should be an object where the keys are the entity types. The values should be lists of entities, i.e. arrays of value objects with at lead an `id` key. For instance:
 
@@ -78,6 +56,48 @@ Your data file should be an object where the keys are the entity types. The valu
 }
 ```
 
+Start the GraphQL server on localhost, port 3000.
+
+```sh
+json-graphql-server db.json
+```
+
+Now you can query your data in graphql. For instance, to issue the following query:
+
+```graphql
+query {
+    Customer(id: 1) {
+        id
+        first_name
+        last_name
+    }
+}
+```
+
+Go to http://localhost:3000/?query=query%20%7B%20Post(id%3A%201)%20%7Bid%20title%20views%20%7D%7D. You'll get the following result:
+
+```json
+{
+    "data": {
+        "Post": {
+            "id": "1",
+            "title": "Lorem Ipsum",
+            "views": 254,
+        }
+    }
+}
+```
+
+The json-graphql-server accepts queries in GET and POST. Under the hood, it uses [Apollo's `graphql-server` module](http://dev.apollodata.com/tools/graphql-server/requests.html). Please refer to their documentations for details about passing variables, etc.
+
+Note that the server is [GraphiQL](https://github.com/skevy/graphiql-app/releases) enabled.
+
+## Install
+
+```sh
+npm install -g json-graphql-server
+```
+
 ## Generated Types and Queries
 
 Based on your data, json-graphql-server will generate a schema with one type per entity, as well as 3 query types and 3 mutation types. For instance for the `Post` entity:
@@ -172,6 +192,30 @@ Here is how you can use the queries and mutations generated for your data, using
     </tr>
 </table>
 
+
+## Usage with Node
+
+Install the module locally
+
+```sh
+npm install --save-dev json-graphql-server
+```
+
+Then use the `jsonGraphqlExpress` express middleware:
+
+```js
+import express from 'express';
+import { jsonGraphqlExpress } from 'json-graphql-server';
+
+const PORT = 3000;
+const app = express();
+const data = {
+    // ... your data
+};
+app.use('/graphql', jsonGraphqlExpress(data));
+app.listen(PORT);
+```
+
 ## Adding Authentication, Custom Routes, etc.
 
 `json-graphql-server` doesn't deal with authentication or custom routes. But you can use your favorite middleware with Express:
@@ -196,6 +240,12 @@ app.listen(PORT);
 
 Deploy with Heroku or Next.js.
 
+## Roadmap
+
+* Handle relationships
+* Client-side mocking (à la [FakeRest](https://github.com/marmelab/FakeRest))
+* CLI options (port, https, watch, delay, custom schema)
+
 ## Contributing
 
 Use Prettier formatting and make sure you include unit tests. The project includes a `Makefile` to automate usual developer tasks: