From 2d87f527bf5f6d74f271b5b6649119a781243d55 Mon Sep 17 00:00:00 2001
From: Syrus Akbary <me@syrusakbary.com>
Date: Fri, 25 Sep 2015 23:31:53 -0700
Subject: [PATCH] Added Relay Schema example

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)

diff --git a/README.md b/README.md
index 73290509..187481ed 100644
--- a/README.md
+++ b/README.md
@@ -77,6 +77,62 @@ query = '''
 result = Schema.execute(query)
 ```
 
+### Relay Schema
+
+Graphene also supports Relay, check the (Starwars Relay example)[/tests/starwars_relay]!
+
+```python
+import graphene
+from graphene import relay
+
+class Ship(relay.Node):
+    '''A ship in the Star Wars saga'''
+    name = graphene.StringField(description='The name of the ship.')
+
+    @classmethod
+    def get_node(cls, id):
+        ship = getShip(id)
+        if ship:
+            return Ship(ship)
+
+
+class Faction(relay.Node):
+    '''A faction in the Star Wars saga'''
+    name = graphene.StringField(description='The name of the faction.')
+    ships = relay.ConnectionField(Ship, description='The ships used by the faction.')
+
+    @resolve_only_args
+    def resolve_ships(self, **kwargs):
+        return [Ship(getShip(ship)) for ship in self.instance.ships]
+
+    @classmethod
+    def get_node(cls, id):
+        faction = getFaction(id)
+        if faction:
+            return Faction(faction)
+
+
+class Query(graphene.ObjectType):
+    rebels = graphene.Field(Faction)
+    empire = graphene.Field(Faction)
+    node = relay.NodeField()
+
+    @resolve_only_args
+    def resolve_rebels(self):
+        return Faction(getRebels())
+
+    @resolve_only_args
+    def resolve_empire(self):
+        return Faction(getEmpire())
+
+
+Schema = graphene.Schema(query=Query)
+
+# Later on, for querying
+Schema.execute('''rebels { name }''')
+
+```
+
 ## Contributing
 
 After cloning this repo, ensure dependencies are installed by running: