replace readme

Author: chrissm79

README.md

@@ -1,52 +1,63 @@
-# laravel-graphql-relay
+# laravel-grapql-relay #
 
-## Documentation currently under development
+Use Facebook [GraphQL](http://facebook.github.io/graphql/) with [React Relay](https://facebook.github.io/relay/). This package extends graphql-php to work with Laravel and is currently **a work in progress**. You can reference what specifications GraphQL needs to provide to work with Relay in the [documentation](https://facebook.github.io/relay/docs/graphql-relay-specification.html#content).
 
-Use Facebook [GraphQL](http://facebook.github.io/graphql/) with [React Relay](https://facebook.github.io/relay/). This package is used alongside [laravel-graphql](https://github.com/Folkloreatelier/laravel-graphql) and is currently **a work in progress**. You can reference what specifications GraphQL needs to provide to work with Relay in the [documentation](https://facebook.github.io/relay/docs/graphql-relay-specification.html#content).
+Although this package no longer depends on [laraval-graphql](https://github.com/Folkloreatelier/laravel-graphql), it laid the foundation for this package which likely wouldn't exist without it. It is also a great alternative if you are using GraphQL w/o support for Relay.
 
-## Installation
+Because this package is still in the early stages, breaking changes will occur. We will keep the documentation updated with the current release. Please feel free to contribute, PR are absolutely welcome!
+
+### Installation ###
 
 You must then modify your composer.json file and run composer update to include the latest version of the package in your project.
 
-```json
+```php
 "require": {
-    "nuwave/laravel-graphql-relay": "0.1.*"
+    "nuwave/laravel-graphql-relay": "0.3.*"
 }
 ```
 
-Or you can use the ```composer require``` command from your terminal.
+Or you can use the composer require command from your terminal.
 
-```json
+```
 composer require nuwave/laravel-graphql-relay
 ```
 
 Add the service provider to your ```app/config.php``` file
 
-```php
-Nuwave\Relay\ServiceProvider::class
+```
+Nuwave\Relay\LaravelServiceProvider::class
 ```
 
-Add the following entries to your ```config/graphql.php``` file ([laravel-graphql configuration file](https://github.com/Folkloreatelier/laravel-graphql#installation-1))
+Add the Relay & GraphQL facade to your app/config.php file
 
-```php
+```
+'GraphQL' => Nuwave\Relay\Facades\GraphQL::class,
+'Relay' => Nuwave\Relay\Facades\Relay::class,
+```
+
+Publish the configuration file
+
+```
+php artisan vendor:publish --provider="Nuwave\Relay\LaravelServiceProvider"
+```
+
+Create a ```schema.php``` file and add the path to the config
+
+```
+// config/relay.php
+// ...
 'schema' => [
-    'query' => [
-        // ...
-        'node' => Nuwave\Relay\Node\NodeQuery::class,
-    ],
-    // ...
+    'path'      => 'Http/schema.php',
+    'output'    => null,
 ],
-'types' => [
-    // ...
-    'node' => Nuwave\Relay\Node\NodeType::class,
-    'pageInfo' => Nuwave\Relay\Types\PageInfoType::class,
-]
 ```
 
-To generate a ```schema.json``` file (used with the [Babel Relay Plugin](https://facebook.github.io/relay/docs/guides-babel-plugin.html#content))
+To generate a ```schema.json``` file (used with the Babel Relay Plugin):
 
-```php
+```
 php artisan relay:schema
 ```
 
-For additional documentation, please read the [Wiki](https://github.com/nuwave/laravel-graphql-relay/wiki/1.-GraphQL-and-Relay)
+*You can customize the output path in the ```relay.php``` config file under ```schema.output```*
+
+For additional documentation, look through the docs folder or read the Wiki.