Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update tonic-web readme #711

Closed
wants to merge 1 commit into from
Closed

chore: Update tonic-web readme #711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ implementation.
health checking service][healthcheck]. Also serves as an example of both unary and response streaming.
- [`tonic-reflection`](https://github.com/hyperium/tonic/tree/master/tonic-reflection): A tonic based gRPC
reflection implementation.
- [`tonic-web`](https://github.com/hyperium/tonic/tree/master/tonic-web): [grpc-web][grpc-web] protocol translation for Tonic services.
- [`examples`](https://github.com/hyperium/tonic/tree/master/examples): Example gRPC implementations showing off
tls, load balancing and bi-directional streaming.
- [`interop`](https://github.com/hyperium/tonic/tree/master/interop): Interop tests implementation.
Expand Down Expand Up @@ -117,3 +118,4 @@ terms or conditions.
[helloworld-tutorial]: https://github.com/hyperium/tonic/blob/master/examples/helloworld-tutorial.md
[healthcheck]: https://github.com/grpc/grpc/blob/master/doc/health-checking.md
[rust-analyzer]: https://rust-analyzer.github.io
[grpc-web]: https://github.com/grpc/grpc-web
11 changes: 6 additions & 5 deletions tonic-web/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,15 @@ external proxy.

## Examples

[tonic-web-demo][1]: React+Typescript app that talking to a tonic-web enabled service using HTTP/1 or TLS.
[tonic-web-demo][tonic-web-demo]: React+Typescript app that talking to a tonic-web enabled service using HTTP/1 or TLS.

[conduit][2]: An (in progress) implementation of the [realworld][3] demo in Tonic+Dart+Flutter. This app shows how
[conduit][conduit]: An (in progress) implementation of the [realworld][realworld] demo in Tonic+Dart+Flutter. This app shows how
the same client implementation can talk to the same tonic-web enabled server using both `grpc` and `grpc-web` protocols
just by swapping the channel implementation.

When the client is compiled for desktop, ios or android, a grpc `ClientChannel` implementation is used.
When compiled for the web, a `GrpcWebClientChannel.xhr` implementation is used instead.``
[1]: https://github.com/alce/tonic-web-demo
[2]: https://github.com/alce/conduit
[3]: https://github.com/gothinkster/realworld

[tonic-web-demo]: https://github.com/alce/tonic-web-demo
[conduit]: https://github.com/alce/conduit
[realworld]: https://github.com/gothinkster/realworld