Skip to content

Commit 2cd7695

Browse files
committed
Document graphql_client_web in the READMEs
1 parent c39a41f commit 2cd7695

File tree

2 files changed

+15
-17
lines changed

2 files changed

+15
-17
lines changed

README.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,17 @@ A typed GraphQL client library for Rust.
99

1010
## Features
1111

12-
- Precise types for query variables and responses
13-
- Supports GraphQL fragments, objects, unions, inputs, enums, custom scalars and input objects
14-
- Works in the browser (WebAssembly)
15-
- Subscriptions support (serialization-deserialization only at the moment)
16-
- Copies documentation from the GraphQL schema to the generated Rust code
17-
- Arbitrary derives on the generated responses
18-
- Arbitrary custom scalars
19-
- Supports multiple operations per query document
12+
- Precise types for query variables and responses.
13+
- Supports GraphQL fragments, objects, unions, inputs, enums, custom scalars and input objects.
14+
- Works in the browser (WebAssembly).
15+
- Subscriptions support (serialization-deserialization only at the moment).
16+
- Copies documentation from the GraphQL schema to the generated Rust code.
17+
- Arbitrary derives on the generated responses.
18+
- Arbitrary custom scalars.
19+
- Supports multiple operations per query document.
2020
- Supports setting GraphQL fields as deprecated and having the Rust compiler check
2121
their use.
22+
- [web client](./graphql_client_web) for boilerplate-free API calls from browsers.
2223

2324
## Getting started
2425

@@ -150,15 +151,7 @@ There is an [`include`](https://doc.rust-lang.org/cargo/reference/manifest.html#
150151

151152
## Examples
152153

153-
See the examples directory in this repository.
154-
155-
## Roadmap
156-
157-
A lot of desired features have been defined in issues.
158-
159-
graphql_client does not provide any networking, caching or other client functionality yet. Integration with different HTTP libraries is planned, although building one yourself is trivial (just send the constructed request payload as JSON with a POST request to a GraphQL endpoint, modulo authentication).
160-
161-
There is an embryonic CLI for downloading schemas - the plan is to make it something similar to `apollo-codegen`.
154+
See the [examples directory](./graphql_client/examples) in this repository.
162155

163156
## Contributors
164157

graphql_client_web/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# graphql_client_web
2+
3+
Make boilerplate-free GraphQL API calls from web browsers using [graphql-client](../README.md) and [wasm-bindgen](https://github.com/alexcrichton/wasm-bindgen).
4+
5+
For usage details, see the [API docs](https://docs.rs/graphql_client/latest/graphql_client_web/), the [example](../graphql_client/examples/call_from_js) and the [tests](./tests/web.rs).

0 commit comments

Comments
 (0)