diff --git a/README.md b/README.md index 5a01050..ea72383 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,38 @@ This implementation will follow JavaScript version as close as possible until Gr ## Overview GraphQL is intended to be a replacement for REST APIs. [Read more](http://facebook.github.io/react/blog/2015/05/01/graphql-introduction.html) about rationale behind it. +Example: +```php +$result = GraphQL::execute( + StarWarsSchema::build(), + 'query HeroNameAndFriendsQuery { + hero { + id + name + friends { + name + } + } + }' +) +``` + +Result returned: +``` +[ + 'hero' => [ + 'id' => '2001', + 'name' => 'R2-D2', + 'friends' => [ + ['name' => 'Luke Skywalker'], + ['name' => 'Han Solo'], + ['name' => 'Leia Organa'], + ] + ] +] +``` + + This PHP implementation is a thin wrapper around your existing data layer and business logic. It doesn't dictate how these layers are implemented or which storage engines are used. Instead it provides tools for creating API for your existing app. These tools include: - Type system - Schema validation and introspection