Skip to content

Commit 5a953e9

Browse files
committed
Updated READMEs
1 parent e407993 commit 5a953e9

File tree

3 files changed

+36
-5
lines changed

3 files changed

+36
-5
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ![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)
22

33

4-
Graphene is a Python library for building GraphQL schemas/types fast and easily.
4+
[Graphene](http://graphene-python.org) is a Python library for building GraphQL schemas/types fast and easily.
55

66
- **Easy to use:** Graphene helps you use GraphQL in Python without effort.
77
- **Relay:** Graphene has builtin support for Relay
@@ -10,6 +10,7 @@ Graphene is a Python library for building GraphQL schemas/types fast and easily.
1010

1111
*What is supported in this Python version?* **Everything**: Interfaces, ObjectTypes, Scalars, Unions and Relay (Nodes, Connections), in addition to queries, mutations and subscriptions.
1212

13+
**NEW**!: [Try graphene online](http://graphene-python.org/playground/)
1314

1415
## Installation
1516

README.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
|Graphene Logo| `Graphene <http://graphene-python.org>`__ |Build Status| |PyPI version| |Coverage Status|
22
=========================================================================================================
33

4-
Graphene is a Python library for building GraphQL schemas/types fast and
5-
easily.
4+
`Graphene <http://graphene-python.org>`__ is a Python library for
5+
building GraphQL schemas/types fast and easily.
66

77
- **Easy to use:** Graphene helps you use GraphQL in Python without
88
effort.
@@ -16,6 +16,9 @@ easily.
1616
ObjectTypes, Scalars, Unions and Relay (Nodes, Connections), in addition
1717
to queries, mutations and subscriptions.
1818

19+
**NEW**!: `Try graphene
20+
online <http://graphene-python.org/playground/>`__
21+
1922
Installation
2023
------------
2124

docs/README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Graphene Docs
2-
Docs for Graphene
2+
3+
Graphene docs are powered by [gatsby](https://github.com/gatsbyjs/gatsby).
34

45

56
## Installation
@@ -13,4 +14,30 @@ And then
1314

1415
```bash
1516
gatsby develop
16-
```
17+
```
18+
19+
## Playground
20+
21+
If you want to have the playground running too, just execute
22+
23+
```
24+
./playground/graphene-js/build.sh
25+
```
26+
27+
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.
28+
29+
30+
## Build
31+
32+
For building the docs into the `public` dir, just run:
33+
34+
```bash
35+
npm run build
36+
```
37+
38+
39+
## Automation
40+
41+
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.
42+
43+
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.

0 commit comments

Comments
 (0)