Skip to content

Commit ec0efe2

Browse files
committed
readme: document graphql-ws-client as solution for runtime subscriptions
closes #448
1 parent 17d00a8 commit ec0efe2

File tree

2 files changed

+16
-67
lines changed

2 files changed

+16
-67
lines changed

Cargo.lock

+9-66
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A typed GraphQL client library for Rust.
1111
- Precise types for query variables and responses.
1212
- Supports GraphQL fragments, objects, unions, inputs, enums, custom scalars and input objects.
1313
- Works in the browser (WebAssembly).
14-
- Subscriptions support (serialization-deserialization only at the moment).
14+
- Subscriptions support.
1515
- Copies documentation from the GraphQL schema to the generated Rust code.
1616
- Arbitrary derives on the generated responses.
1717
- Arbitrary custom scalars.
@@ -185,6 +185,12 @@ pub struct Heights;
185185

186186
There is an example [in the tests](./graphql_client/tests/operation_selection).
187187

188+
## Subscriptions
189+
190+
The subscription variable and response shapes are handled by code generation the same way as for other operation types.
191+
192+
For the runtime part of the story, we recommend the awesome [graphql-ws-client](https://crates.io/crates/graphql-ws-client) by @obmarg.
193+
188194
## Documentation for the generated modules
189195

190196
You can use `cargo doc --document-private-items` to generate rustdoc documentation on the generated code.

0 commit comments

Comments
 (0)