Updated usage instructions

Author: syrusakbary

README.md

@@ -1,14 +1,28 @@
-# `graphql-flask`
+# GraphQL-Flask
 
 [![Build Status](https://travis-ci.org/graphql-python/graphql-flask.svg?branch=master)](https://travis-ci.org/graphql-python/graphql-flask) [![Coverage Status](https://coveralls.io/repos/graphql-python/graphql-flask/badge.svg?branch=master&service=github)](https://coveralls.io/github/graphql-python/graphql-flask?branch=master) [![PyPI version](https://badge.fury.io/py/graphql-flask.svg)](https://badge.fury.io/py/graphql-flask)
 
-A `Flask` package that provides two main views for operate with `GraphQL`:
-* `GraphQLView`: endpoint for expose the GraphQL schema
-* `GraphiQLView`: Graphical Interface for operate with GraphQL easily
+Adds GraphQL support to your Flask application.
 
 ## Usage
-Use it like you would any other Flask View.
 
+Just create a `GraphQL` instance from `graphql_flask`
+
+```python
+from graphql_flask import GraphQL
+
+graphql_blueprint = GraphQL(app, schema=schema)
+```
+
+This will add `/graphql` and `/graphiql` endpoints to your app.
+
+## Customization
+
+This package provides the following Views:
+* `GraphQLView`: endpoint for expose the GraphQL schema
+* `GraphiQLView`: Graphical Interface for operate with GraphQL easily
+
+You can also add only the views you want to use:
 ```python
 from graphql_flask import GraphQLView, GraphiQLView
 
@@ -20,6 +34,7 @@ app.add_url_rule('/graphql', view_func=GraphQLView.as_view('graphql', schema=sch
  * `pretty`: Whether or not you want the response to be pretty printed JSON.
  * `executor`: The `Executor` that you want to use to execute queries.
  * `root_value`: The `root_value` you want to provide to `executor.execute`.
+ * `default_query`: The `default_query` you want to provide to GraphiQL interface.
 
 You can also subclass `GraphQLView` and overwrite `get_root_value(self, request)` to have a dynamic root value
 per request.

README.rst

@@ -0,0 +1,65 @@
+GraphQL-Flask
+=============
+
+|Build Status| |Coverage Status| |PyPI version|
+
+Adds GraphQL support to your Flask application.
+
+Usage
+-----
+
+Just create a ``GraphQL`` instance from ``graphql_flask``
+
+.. code:: python
+
+    from graphql_flask import GraphQL
+
+    graphql_blueprint = GraphQL(app, schema=schema)
+
+This will add ``/graphql`` and ``/graphiql`` endpoints to your app.
+
+Customization
+-------------
+
+This package provides the following Views: \* ``GraphQLView``: endpoint
+for expose the GraphQL schema \* ``GraphiQLView``: Graphical Interface
+for operate with GraphQL easily
+
+You can also add only the views you want to use:
+
+.. code:: python
+
+    from graphql_flask import GraphQLView, GraphiQLView
+
+    app.add_url_rule('/graphql', view_func=GraphQLView.as_view('graphql', schema=schema))
+
+Supported options
+~~~~~~~~~~~~~~~~~
+
+-  ``schema``: The ``GraphQLSchema`` object that you want the view to
+   execute when it gets a valid request.
+-  ``pretty``: Whether or not you want the response to be pretty printed
+   JSON.
+-  ``executor``: The ``Executor`` that you want to use to execute
+   queries.
+-  ``root_value``: The ``root_value`` you want to provide to
+   ``executor.execute``.
+-  ``default_query``: The ``default_query`` you want to provide to
+   GraphiQL interface.
+
+You can also subclass ``GraphQLView`` and overwrite
+``get_root_value(self, request)`` to have a dynamic root value per
+request.
+
+.. code:: python
+
+    class UserRootValue(GraphQLView):
+        def get_root_value(self, request):
+            return request.user
+
+.. |Build Status| image:: https://travis-ci.org/graphql-python/graphql-flask.svg?branch=master
+   :target: https://travis-ci.org/graphql-python/graphql-flask
+.. |Coverage Status| image:: https://coveralls.io/repos/graphql-python/graphql-flask/badge.svg?branch=master&service=github
+   :target: https://coveralls.io/github/graphql-python/graphql-flask?branch=master
+.. |PyPI version| image:: https://badge.fury.io/py/graphql-flask.svg
+   :target: https://badge.fury.io/py/graphql-flask

setup.py

@@ -5,7 +5,8 @@
 setup(
     name='graphql-flask',
     version='0.0.1',
-    description='A Flask libarary for handle easily graphql',
+    description='Adds GraphQL support to your Flask application',
+    long_description=open('README.rst').read(),
     url='https://github.com/graphql-python/graphql-flask',
     download_url='https://github.com/graphql-python/graphql-flask/releases',
     author='Syrus Akbary',