diff --git a/README.md b/README.md index e3cc7e00..f0546eeb 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ -# graphql -[![Pub](https://img.shields.io/pub/v/angel_graphql.svg)](https://pub.dartlang.org/packages/angel_graphql) -[![build status](https://travis-ci.org/angel-dart/graphql.svg)](https://travis-ci.org/angel-dart/graphql) +![Logo](https://github.com/angel-dart/graphql/raw/master/img/angel_logo.png) + +
+ A complete implementation of the official -[GraphQL specification](http://facebook.github.io/graphql/October2016/#sec-Language), +[GraphQL specification](https://graphql.github.io/graphql-spec/June2018/), in the Dart programming language. The goal of this project is to provide to server-side @@ -13,4 +18,18 @@ Included is also `package:angel_graphql`, which, when combined with the [Angel](https://github.com/angel-dart) framework, allows server-side Dart users to build backends with GraphQL and -virtually any database imaginable. \ No newline at end of file +virtually any database imaginable. + +## Projects +This mono repo is split into several sub-projects, +each with its own detailed documentation and examples: +* `angel_graphql` - Support for handling GraphQL via HTTP and +WebSockets in the [Angel](https://angel-dart.dev) framework. Also serves as the `package:graphql_server` reference implementation. +* `example_star_wars`: An example GraphQL API built using +`package:angel_graphql`. +* `graphql_generator`: Generates `package:graphql_schema` object types from concrete Dart classes. +* `graphql_parser`: A recursive descent parser for the GraphQL language. +* `graphql_schema`: An implementation of GraphQL's type system. This, combined with `package:graphql_parser`, +powers `package:graphql_server`. +* `graphql_server`: Base functionality for implementing GraphQL servers in Dart. Has no dependency on any +framework. \ No newline at end of file