docs: create a base version of README followed by code examples

Author: lyskos97

README.md

@@ -7,16 +7,88 @@
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 [![Greenkeeper badge](https://badges.greenkeeper.io/graphql-compose/graphql-compose-rest.svg)](https://greenkeeper.io/)
 
-
 This is a plugin for [graphql-compose](https://github.com/nodkz/graphql-compose), which derives GraphQLType from REST response. Also derives bunch of internal GraphQL Types.
 
-Installation
-============
+## Getting started
+
+### Demo
+
+We have a [demo app](demo/) which shows how to build an API upon [SWAPI](https://swapi.co) using `graphql-compose-rest`.
+
+You can run it using:
+
+```js
+npm run demo
+```
+
+### Installation
+
 ```
 npm install graphql graphql-compose graphql-compose-rest --save
 ```
-Modules `graphql`, `graphql-compose`, are in `peerDependencies`, so should be installed explicitly in your app. They have global objects and should not have ability to be installed as submodule.
 
-License
-=======
+Modules `graphql`, `graphql-compose`, are located in `peerDependencies`, so they should be installed explicitly in your app. They have global objects and should not have ability to be installed as submodule.
+
+### Examples
+
+We have a sample response object:
+
+```js
+const responseFromRestApi = {
+  name: 'Anakin Skywalker',
+  birth_year: '41.9BBY',
+  gender: 'male',
+  homeworld: 'https://swapi.co/api/planets/1/',
+  films: [
+    'https://swapi.co/api/films/5/',
+    'https://swapi.co/api/films/4/',
+    'https://swapi.co/api/films/6/',
+  ],
+  species: ['https://swapi.co/api/species/1/'],
+  starships: [
+    'https://swapi.co/api/starships/59/',
+    'https://swapi.co/api/starships/65/',
+    'https://swapi.co/api/starships/39/',
+  ],
+};
+```
+
+which we pass to a `composeWithRest` function of `graphql-compose-rest` along with desired type name as first argument in order to generate a `GraphQL` type:
+
+```js
+const PersonTC = composeWithRest('Person', responseFromRestApi);
+```
+
+and successfully export for furher usage:
+
+```js
+export PersonTC;
+```
+
+If you want to specify new fields for your type, just use the `addField` function of `TypeComposer` type of `graphql-compose`:
+
+```js
+PersonTC.addFields({
+  weapon: { // standard GraphQL like field definition
+    type: GraphQLString,
+    resolve: (source) => source.name.toUpperCase(),
+  },
+});
+```
+
+In case you want to create a relation with another type simply use `addRelation` function of `TypeComposer`:
+
+```js
+PersonTC.addRelation('filmObjects', { // uses shortened syntax
+  resolver: () => FilmTC.getResolver('findByUrlList'),
+  prepareArgs: { // you're free to define `resolve` the way you want
+    urls: source => source.films,
+  },
+});
+```
+
+`graphql-compose` provides a vast variety of methods for types' `fields` and `resolvers` (aka `field configs` in vanilla `GraphQL`) management. To learn more visit [graphql-compose repo](https://github.com/nodkz/graphql-compose).
+
+## License
+
 [MIT](https://github.com/graphql-compose/graphql-compose-rest/blob/master/LICENSE.md)

demo/utils.js

@@ -10,8 +10,10 @@ export function createFindByIdResolver(tc: TypeComposer, urlAddr: string): void
     args: {
       id: 'Int!',
     },
-    resolve: rp => {
-      return fetch(`https://swapi.co/api/${urlAddr}/${rp.args.id}/`).then(r => r.json());
+    resolve: async rp => {
+      const res = await fetch(`https://swapi.co/api/${urlAddr}/${rp.args.id}/`);
+      const data = await res.json();
+      return data;
     },
   });
 }
@@ -24,8 +26,8 @@ export function createFindListByPageNumberResolver(tc: TypeComposer, urlAddr: st
       page: { type: 'Int', defaultValue: 1 },
     },
     resolve: async rp => {
-      const response = await fetch(`https://swapi.co/api/${urlAddr}/?page=${rp.args.page}`);
-      const data = await response.json();
+      const res = await fetch(`https://swapi.co/api/${urlAddr}/?page=${rp.args.page}`);
+      const data = await res.json();
       return data.results;
     },
   });
@@ -39,7 +41,11 @@ export function createFindByUrlListResolver(tc: TypeComposer): void {
       urls: '[String]!',
     },
     resolve: rp => {
-      return Promise.all(rp.args.urls.map(url => fetch(url).then(r => r.json())));
+      return rp.args.urls.map(async url => {
+        const res = await fetch(url);
+        const data = await res.json();
+        return data;
+      });
     },
   });
 }