Merge pull request #243 from mcg-web/improve-documentation

Improve documentation

Author: renatomefi

README.md

@@ -1,13 +1,16 @@
 OverblogGraphQLBundle
 ======================
 
-This Symfony 2 / 3 bundle provide integration [GraphQL](https://facebook.github.io/graphql/) using [webonyx/graphql-php](https://github.com/webonyx/graphql-php)
+This Symfony bundle provides integration of [GraphQL](https://facebook.github.io/graphql/) using [webonyx/graphql-php](https://github.com/webonyx/graphql-php)
 and [GraphQL Relay](https://facebook.github.io/relay/docs/graphql-relay-specification.html).
 It also supports batching using libs like [ReactRelayNetworkLayer](https://github.com/nodkz/react-relay-network-layer) or [Apollo GraphQL](http://dev.apollodata.com/core/network.html#query-batching).
 
 [![Build Status](https://travis-ci.org/overblog/GraphQLBundle.svg?branch=master)](https://travis-ci.org/overblog/GraphQLBundle)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/overblog/GraphQLBundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/overblog/GraphQLBundle/?branch=master)
 [![Coverage Status](https://coveralls.io/repos/github/overblog/GraphQLBundle/badge.svg?branch=master)](https://coveralls.io/github/overblog/GraphQLBundle?branch=master)
+[![Latest Stable Version](https://poser.pugx.org/overblog/graphql-bundle/version)](https://packagist.org/packages/overblog/graphql-bundle)
+[![Latest Unstable Version](https://poser.pugx.org/overblog/graphql-bundle/v/unstable)](https://packagist.org/packages/overblog/graphql-bundle)
+[![Total Downloads](https://poser.pugx.org/overblog/graphql-bundle/downloads)](https://packagist.org/packages/overblog/graphql-bundle)
 
 Documentation
 -------------
@@ -25,6 +28,7 @@ Documentation
     - [Non-Null](Resources/doc/definitions/type-system/non-null.md)
   - [Schema](Resources/doc/definitions/schema.md)
   - [Resolver](Resources/doc/definitions/resolver.md)
+  - [Solving N+1 problem](Resources/doc/definitions/solving-n-plus-1-problem.md)
   - [Mutation](Resources/doc/definitions/mutation.md)
   - [Relay](Resources/doc/definitions/relay/index.md)
     - [Connection](Resources/doc/definitions/relay/connection.md)
@@ -60,7 +64,7 @@ Talks and slides to help you start
   - [Video at SymfonyCamp UA 2017](https://www.youtube.com/watch?v=jyoYlnCPNgk) `English`
   - [Video at DPC 2017](https://www.youtube.com/watch?v=E7MjoCOGSSY) `English`
 * A GraphQL API: From hype to production *by Aurélien David* - [Twitter](https://twitter.com/spyl94), [GitHub](https://github.com/spyl94)
-  - [Slides at https://spyl.net/slides/symfonycon-cluj-2017](https://spyl.net/slides/symfonycon-cluj-2017/) `English`
+  - [Slides at https://spyl.net/slides/symfonycon-cluj-2017](https://spyl.net/slides/symfonycon-cluj-2017) `English`
 * Une API GraphQL: du hype à la prod *by Aurélien David* - [Twitter](https://twitter.com/spyl94), [GitHub](https://github.com/spyl94)
   - [Video at PHPTour 2017 Nantes](https://www.youtube.com/watch?v=xbipW6fgD6c) `French`
 * Introduction to Symfony Flex and setting up OverblogGraphQLBundle with it *by Renato Mendes Figueiredo* - [Twitter](https://twitter.com/renatomefi), [GitHub](https://github.com/renatomefi)

Resources/doc/definitions/resolver.md

@@ -165,3 +165,5 @@ Resolvers can be define 2 different ways
     ```
     `addition` mutation can be access by using `App\GraphQL\Mutation\CalcMutation::addition` or
     `add` alias.
+
+Next step [solving N+1 problem](solving-n-plus-1-problem.md)

Resources/doc/definitions/solving-n-plus-1-problem.md

@@ -0,0 +1,7 @@
+Solving N+1 Problem
+====================
+
+As explained in [GraphQL-PHP documentation](https://github.com/webonyx/graphql-php/blob/master/docs/data-fetching.md),
+solving N+1 Problem can be a requirement to make your application production ready.
+For that reason, we also provide a bundle [overblog/dataloader-bundle](https://github.com/overblog/dataloader-bundle)
+based on [facebook dataloader](https://github.com/facebook/dataloader) answering easily to this need.

Resources/doc/index.md

@@ -1,13 +1,18 @@
 OverblogGraphQLBundle
 ======================
 
-This Symfony 2 / 3 bundle provide integration [GraphQL](https://facebook.github.io/graphql/) using [webonyx/graphql-php](https://github.com/webonyx/graphql-php)
+This Symfony bundle provides integration of [GraphQL](https://facebook.github.io/graphql/) using [webonyx/graphql-php](https://github.com/webonyx/graphql-php)
 and [GraphQL Relay](https://facebook.github.io/relay/docs/graphql-relay-specification.html).
 It also supports batching using libs like [ReactRelayNetworkLayer](https://github.com/nodkz/react-relay-network-layer) or [Apollo GraphQL](http://dev.apollodata.com/core/network.html#query-batching).
 
 Requirements
 ------------
-PHP >= 5.5
+
+| Version                                                     | PHP         | Symfony           |
+|------------------------------------------------------------:|------------:|------------------:|
+| `>= 0.10`                                                   |  `>= 5.6`   |  `>= 3.1`         |
+| [`0.9`](https://github.com/overblog/GraphQLBundle/tree/0.9) |  `>= 5.5.9` |  `>= 2.8, <= 3.1` |
+| [`0.8`](https://github.com/overblog/GraphQLBundle/tree/0.8) |  `>= 5.4 `  |  `>= 2.7, <= 3.1` |
 
 After installation
 ------------