From a682ef8bc3d7ca45e5e303cbe0ec89a9e90430d5 Mon Sep 17 00:00:00 2001 From: Syrus Akbary Date: Fri, 30 Oct 2015 00:01:44 -0700 Subject: [PATCH] Updated READMES --- README.md | 12 ++++++++---- README.rst | 22 ++++++++++++++-------- 2 files changed, 22 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 64934038..aff53fa1 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,14 @@ Graphene is a Python library for building GraphQL schemas/types fast and easily. -* **Easy to use:** It maps the models/fields to internal GraphQL objects without effort. +* **Easy to use:** Graphene helps you use GraphQL in Python without effort. * **Relay:** Graphene has builtin support for Relay * **Django:** Automatic *Django model* mapping to Graphene Types. *See an [example Django](http://github.com/graphql-python/swapi-graphene) implementation* +*But, what is supported in this Python version?* **Everything**: Interfaces, ObjectTypes, Mutations and Relay (Nodes, Connections and Mutations). + + ## Installation For instaling graphene, just run this command in your shell @@ -49,10 +52,11 @@ query = ''' result = schema.execute(query) ``` -If you want to learn even more, you can also check the following examples: +If you want to learn even more, you can also check the following [examples](examples/): -* Relay Schema: [Starwars Relay example](examples/starwars_relay) -* Django: [Starwars Django example](examples/starwars_django) +* **Basic Schema**: [Starwars example](examples/starwars) +* **Relay Schema**: [Starwars Relay example](examples/starwars_relay) +* **Django model mapping**: [Starwars Django example](examples/starwars_django) ## Contributing diff --git a/README.rst b/README.rst index eaec71fd..cef04124 100644 --- a/README.rst +++ b/README.rst @@ -2,13 +2,16 @@ ========================================================================================================= Graphene is a Python library for building GraphQL schemas/types fast and -easily. \* **Easy to use:** It maps the models/fields to internal -GraphQL objects without effort. \* **Relay:** Graphene has builtin -support for Relay \* **Django:** Automatic *Django model* mapping to -Graphene Types. *See an `example -Django `__ +easily. \* **Easy to use:** Graphene helps you use GraphQL in Python +without effort. \* **Relay:** Graphene has builtin support for Relay \* +**Django:** Automatic *Django model* mapping to Graphene Types. *See an +`example Django `__ implementation* +*But, what is supported in this Python version?* **Everything**: +Interfaces, ObjectTypes, Mutations and Relay (Nodes, Connections and +Mutations). + Installation ------------ @@ -53,10 +56,13 @@ Then Querying ``graphene.Schema`` is as simple as: result = schema.execute(query) If you want to learn even more, you can also check the following -examples: +`examples `__: -- Relay Schema: `Starwars Relay example `__ -- Django: `Starwars Django example `__ +- **Basic Schema**: `Starwars example `__ +- **Relay Schema**: `Starwars Relay + example `__ +- **Django model mapping**: `Starwars Django + example `__ Contributing ------------