Skip to content

Commit 23eb7b5

Browse files
committed
Update readme
1 parent 9e27e80 commit 23eb7b5

File tree

4 files changed

+17
-9
lines changed

4 files changed

+17
-9
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
[![build status](https://img.shields.io/github/workflow/status/wantedly/proto-graphql-rust/CI/master?style=flat-square&logo=github)](https://github.com/wantedly/proto-graphql-rust/actions)
44

5+
**[EXPERIMENTAL]** Generate GraphQL schema and gateway from Proto definitions.
6+
7+
## Examples
8+
9+
- [Simple graphql-gateway](examples/simple)
10+
- [Streaming RPC / Subscription](examples/subscription)
11+
- [Apollo Federation](examples/federation)
12+
513
## License
614

715
Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or

examples/federation/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Apollo Federation example
1+
# Apollo Federation
22

33
## How to run
44

@@ -7,9 +7,9 @@ cd examples/simple
77
./start.sh
88
```
99

10-
Open http://localhost:4000 in browser.
10+
Then, open <http://localhost:4000> in browser.
1111

12-
[Generated GraphQL schema](graphql/graphql-gateway.graphql)
12+
[*Generated GraphQL schema*](graphql/graphql-gateway.graphql)
1313

1414
Query example:
1515

examples/simple/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Simple graphql-gateway example
1+
# Simple graphql-gateway
22

33
## How to run
44

@@ -7,9 +7,9 @@ cd examples/simple
77
./start.sh
88
```
99

10-
Open http://localhost:4000 in browser.
10+
Then, open <http://localhost:4000> in browser.
1111

12-
[Generated GraphQL schema](graphql/simple-graphql-gateway.graphql)
12+
[*Generated GraphQL schema*](graphql/simple-graphql-gateway.graphql)
1313

1414
Query example:
1515

examples/subscription/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Server Streaming RPC example
1+
# Streaming RPC / Subscription
22

33
## How to run
44

@@ -7,9 +7,9 @@ cd examples/subscription
77
./start.sh
88
```
99

10-
Open http://localhost:4000 in browser.
10+
Then, open <http://localhost:4000> in browser.
1111

12-
[Generated GraphQL schema](graphql/subscription-graphql-gateway.graphql)
12+
[*Generated GraphQL schema*](graphql/subscription-graphql-gateway.graphql)
1313

1414
Subscription example:
1515

0 commit comments

Comments
 (0)