From 5a953e9a57674736a6db6018b4e5f5ab608ccb5a Mon Sep 17 00:00:00 2001 From: Syrus Akbary Date: Mon, 30 Nov 2015 00:25:18 -0800 Subject: [PATCH] Updated READMEs --- README.md | 3 ++- README.rst | 7 +++++-- docs/README.md | 31 +++++++++++++++++++++++++++++-- 3 files changed, 36 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 115d4a14..e36ac257 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # ![Graphene Logo](http://graphene-python.org/favicon.png) [Graphene](http://graphene-python.org) [![Build Status](https://travis-ci.org/graphql-python/graphene.svg?branch=master)](https://travis-ci.org/graphql-python/graphene) [![PyPI version](https://badge.fury.io/py/graphene.svg)](https://badge.fury.io/py/graphene) [![Coverage Status](https://coveralls.io/repos/graphql-python/graphene/badge.svg?branch=master&service=github)](https://coveralls.io/github/graphql-python/graphene?branch=master) -Graphene is a Python library for building GraphQL schemas/types fast and easily. +[Graphene](http://graphene-python.org) is a Python library for building GraphQL schemas/types fast and easily. - **Easy to use:** Graphene helps you use GraphQL in Python without effort. - **Relay:** Graphene has builtin support for Relay @@ -10,6 +10,7 @@ Graphene is a Python library for building GraphQL schemas/types fast and easily. *What is supported in this Python version?* **Everything**: Interfaces, ObjectTypes, Scalars, Unions and Relay (Nodes, Connections), in addition to queries, mutations and subscriptions. +**NEW**!: [Try graphene online](http://graphene-python.org/playground/) ## Installation diff --git a/README.rst b/README.rst index ea5e2635..1d427010 100644 --- a/README.rst +++ b/README.rst @@ -1,8 +1,8 @@ |Graphene Logo| `Graphene `__ |Build Status| |PyPI version| |Coverage Status| ========================================================================================================= -Graphene is a Python library for building GraphQL schemas/types fast and -easily. +`Graphene `__ is a Python library for +building GraphQL schemas/types fast and easily. - **Easy to use:** Graphene helps you use GraphQL in Python without effort. @@ -16,6 +16,9 @@ easily. ObjectTypes, Scalars, Unions and Relay (Nodes, Connections), in addition to queries, mutations and subscriptions. +**NEW**!: `Try graphene +online `__ + Installation ------------ diff --git a/docs/README.md b/docs/README.md index 2a8f240f..7ecaea8e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,6 @@ # Graphene Docs -Docs for Graphene + +Graphene docs are powered by [gatsby](https://github.com/gatsbyjs/gatsby). ## Installation @@ -13,4 +14,30 @@ And then ```bash gatsby develop -``` \ No newline at end of file +``` + +## Playground + +If you want to have the playground running too, just execute + +``` +./playground/graphene-js/build.sh +``` + +This command will clone the [pypyjs-release-nojit](https://github.com/pypyjs/pypyjs-release-nojit) repo, update it with the latest graphene, graphql-core and graphql-relay code, and make it available for the `/playground` view in the docs. + + +## Build + +For building the docs into the `public` dir, just run: + +```bash +npm run build +``` + + +## Automation + +Thanks to [Travis](https://github.com/graphql-python/graphene/blob/master/.travis.yml#L39-L58), we automated the way documentation is updated in the `gh-pages` branch. + +Each time we modify the docs in the `master` branch the travis job runs and updates the `gh-pages` branch with the latest code, so [Graphene's website](http://graphene-python.org) have always the latest docs.