Document customized derives on responses

Author: tomhoule

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - (breaking) Control over which types custom scalars deserialize to is given to the user: you now have to provide type aliases for the custom scalars in the scope of the struct under derive.
 - (breaking) Support for multi-operations documents. You can select a particular operation by naming the struct under derive after it. In case there is no match, we revert to the current behaviour: select the first operation.
+- Support arbitrary derives on the generated response types via the `response_derives` option on the `graphql` attribute.
 
 ## [0.3.0] - 2018-07-24
 

README.md

@@ -13,6 +13,7 @@ A typed GraphQL client library for Rust.
 - Works in the browser (WebAssembly)
 - Subscriptions support (serialization-deserialization only at the moment)
 - Copies documentation from the GraphQL schema to the generated Rust code
+- Arbitrary derives on the generated responses
 
 ## Getting started
 
@@ -74,6 +75,21 @@ A typed GraphQL client library for Rust.
 
 [A complete example using the GitHub GraphQL API is available](https://github.com/tomhoule/graphql-client/tree/master/examples/github), as well as sample [rustdoc output](https://www.tomhoule.com/docs/example_module/).
 
+## Deriving specific traits on the response
+
+The generated response types always derive `serde::Deserialize` but you may want to print them (`Debug`), compare them (`PartialEq`) or derive any other trait on it. You can achieve this with the `response_derives` option of the `graphql` attribute. Example:
+
+```rust
+#[derive(GraphQLQuery)]
+#[graphql(
+  schema_path = "src/search_schema.graphql",
+  query_path = "src/search_query.graphql"
+  query_path = "src/search_query.graphql",
+  response_derives = "Serialize,PartialEq",
+)]
+struct SearchQuery;
+```
+
 ## Examples
 
 See the examples directory in this repository.