🎉 Version bump

Author: HofmannZ

CHANGELOG.md

@@ -1,9 +1,25 @@
+## [0.7.0] - July 22 2018
+
+### Breaking change
+
+n/a
+
+#### Fixes / Enhancements
+
+- Added support for subsciptionsin the client.
+- Added the `Subscription` widget. You can no direcly acces streams from Flutter.
+
+#### Docs
+
+- Added instructions for adding subscripton to your poject.
+- Updated the `About this project` section.
+
 ## [0.6.0] - July 19 2018
 
 ### Breaking change
 
-- The library now requires your app to be wrapped with the `GraphqlProvider` widget @HofmannZ
-- The global `client` variable is no longer available. Instead use the `GraphqlConsumer` widget
+- The library now requires your app to be wrapped with the `GraphqlProvider` widget.
+- The global `client` variable is no longer available. Instead use the `GraphqlConsumer` widget.
 
 #### Fixes / Enhancements
 
@@ -46,7 +62,7 @@ n/a
 
 - Query: changed `Timer` to `Timer.periodic` @eusdima
 - Minor logic tweak @eusdima
-- Use absolute paths in the library @HofmannZ
+- Use absolute paths in the library
 
 #### Docs
 

README.md

@@ -10,24 +10,36 @@
 
 ## Table of Contents
 
+- [About this project](#about-this-project)
 - [Installation](#installation)
 - [Usage](#usage)
   - [Graphql Provider](#graphql-provider)
   - [Queries](#queries)
   - [Mutations](#mutations)
+  - [Subscriptions (Experimental)](#subscriptions-experimental)
   - [Graphql Consumer](#graphql-consumer)
-  - [Offline Cache](#offline-cache)
+  - [Offline Cache (Experimental)](#offline-cache-experimental)
 - [Roadmap](#roadmap)
 - [Contributing](#contributing)
 - [Contributors](#contributors)
 
+## About this project
+
+GraphQL brings many benefits, both to the client: devices will need less requests, and therefore reduce data useage. And to the programer: requests are arguable, they have the same structure as the request.
+
+The team at Apollo did a great job implenting GraphQL in Swift, Java and Javascript. But unfortunately they're not planning to release a Dart implementation.
+
+This project is filling the gap, bringing the GraphQL spec to yet another programming language. We plan to implement most functionality from the [Apollo GraphQL client](https://github.com/apollographql/apollo-client) and from most features the [React Apollo](https://github.com/apollographql/react-apollo) components into Dart and Flutter respectively.
+
+With that being said, the project lives currently still inside one package. We plan to spilt up the project into multiple smaler packages in the near future, to follow Apollo's modules design.
+
 ## Installation
 
 First depend on the library by adding this to your packages `pubspec.yaml`:
 
 ```yaml
 dependencies:
-  graphql_flutter: ^0.6.0
+  graphql_flutter: ^0.7.0
 ```
 
 Now inside your Dart code you can import it.
@@ -201,6 +213,64 @@ new Mutation(
 ...
 ```
 
+### Subscriptions (Experimental)
+
+The syntax for subscriptions is again similar to a query, however, this utilizes WebSockets and dart Streams to provide real-time updates from a server.
+Before subscriptions can be performed a global intance of `socketClient` needs to be initialized.
+
+> We are working on moving this into the same `GraphqlProvider` stucture as the http client. Therefore this api might change in the near future.
+
+```dart
+socketClient = await SocketClient.connect('ws://coolserver.com/graphql');
+```
+
+Once the `socketClient` has been initialized it can be used by the `Subscription` `Widget`
+
+```dart
+class _MyHomePageState extends State<MyHomePage> {
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      body: Center(
+        child: Subscription(
+          operationName,
+          query,
+          variables: variables,
+          builder: ({
+            bool loading,
+            dynamic payload,
+            dynamic error,
+          }) {
+            if (payload != null) {
+              return Text(payload['requestSubscription']['requestData']);
+            } else {
+              return Text('Data not found');
+            }
+          }
+        ),
+      )
+    );
+  }
+}
+```
+
+Once the `socketClient` is initialized you could also use it without Flutter.
+
+```dart
+final String operationName = "SubscriptionQuery";
+final String query = """subscription $operationName(\$requestId: String!) {
+  requestSubscription(requestId: \$requestId) {
+    requestData
+  }
+}""";
+final dynamic variables = {
+  'requestId': 'My Request',
+};
+socketClient
+    .subscribe(SubscriptionRequest(operationName, query, variables))
+    .listen(print);
+```
+
 ### Graphql Consumer
 
 You can always access the client direcly from the `GraphqlProvider` but to make it even easier you can also use the `GraphqlConsumer` widget.
@@ -221,7 +291,7 @@ You can always access the client direcly from the `GraphqlProvider` but to make
   ...
 ```
 
-### Offline Cache
+### Offline Cache (Experimental)
 
 The in-memory cache can automatically be saved to and restored from offline storage. Setting it up is as easy as wrapping your app with the `CacheProvider` widget.
 
@@ -248,76 +318,21 @@ class MyApp extends StatelessWidget {
 ...
 ```
 
-### Subscriptions (Experimental)
-
-The syntax for subscriptions is again similar to a query, however, this utilizes WebSockets and dart Streams to provide real-time updates from a server.
-Before subscriptions can performed the following code is required for initializing the global `socketClient` instance.
-
-```dart
-socketClient = await SocketClient.connect('ws://coolserver.com/graphql');
-
-// Example non-flutter usage:
-final String operationName = "SubscriptionQuery";
-final String query = """subscription $operationName(\$requestId: String!) {
-  requestSubscription(requestId: \$requestId) {
-    requestData
-  }
-}""";
-final dynamic variables = {
-  'requestId': 'My Request',
-};
-socketClient
-    .subscribe(SubscriptionRequest(operationName, query, variables))
-    .listen(print);
-```
-
-Once the `socketClient` has been initialized it can be used by the `Subscription` `Widget`
-
-```dart
-class _MyHomePageState extends State<MyHomePage> {
-  @override
-  Widget build(BuildContext context) {
-    return Scaffold(
-      body: Center(
-        child: Subscription(
-          operationName,
-          query,
-          variables: variables,
-          builder: ({
-            bool loading,
-            dynamic payload,
-            dynamic error,
-          }) {
-            if (payload != null) {
-              return Text(payload['requestSubscription']['requestData']);
-            } else {
-              return Text('Data not found');
-            }
-          }
-        ),
-      )
-    );
-  }
-}
-```
-
 ## Roadmap
 
 This is currently our roadmap, please feel free to request additions/changes.
 
 | Feature                 | Progress |
 | :---------------------- | :------: |
-| Basic queries           |    ✅    |
-| Basic mutations         |    ✅    |
-| Basic subscriptions     |    🔜    |
-| Query variables         |    ✅    |
-| Mutation variables      |    ✅    |
-| Subscription variables  |    🔜    |
+| Queries                 |    ✅    |
+| Mutations               |    ✅    |
+| Subscriptions           |    ✅    |
 | Query polling           |    ✅    |
-| In memory caching       |    ✅    |
-| Offline caching         |    ✅    |
+| In memory cache         |    ✅    |
+| Offline cache sync      |    ✅    |
 | Optimistic results      |    🔜    |
 | Client state management |    🔜    |
+| Modularity              |    🔜    |
 
 ## Contributing
 

pubspec.yaml

@@ -1,6 +1,6 @@
 name: graphql_flutter
 description: A GraphQL client for Flutter.
-version: 0.6.0
+version: 0.7.0
 authors:
 - Eus Dima <[email protected]>
 - Zino Hofmann <[email protected]>
@@ -11,8 +11,8 @@ dependencies:
     sdk: flutter
   http: ^0.11.0
   path_provider: ^0.4.0
+  uuid: ^1.0.1
   test: ^0.12.0
-  uuid: 1.0.1
 
 dev_dependencies:
   flutter_test: