Update README.md

This commit is contained in:
Wenbo Zhu 2017-10-27 16:07:30 -07:00 committed by GitHub
parent 3298898a87
commit 50e550d459
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 10 deletions

View File

@ -3,23 +3,18 @@
gRPC-Web provides a Javascript client library that enables browser clients to gRPC-Web provides a Javascript client library that enables browser clients to
access a gRPC server. access a gRPC server.
The current release is a Pre-Alpha release, mainly for early adopters to provide The current release is an Alpha release, mainly for early adopters to provide
feedback on the JS API (both gRPC and Protobuf). The JS client library has been feedback on the JS API (both gRPC and Protobuf). The JS client library has been
used by Google (Alphabet) projects with Closure compiler and its TypeScript used by Google (and Alphabet) projects with [Closure compiler](https://github.com/google/closure-compiler)
generator (not yet open-sourced). The use of Closure compiler may or may not fit and its TypeScript generator (not yet open-sourced).
your JS development environment.
The gateway that connects the client to the server uses Nginx. However, Nginx The gateway that connects the client to the server uses Nginx. However, Nginx
still doesn't support HTTP/2 (to backends) as of Q2/2017, and therefore the still doesn't support HTTP/2 (to backends) as of Q3/2017, and therefore the
gateway can't be used as a reverse proxy (for load balancing). We have also gateway can't be used as a reverse proxy (for load balancing). We have also
added the gRPC-Web support to [Envoy](https://github.com/lyft/envoy). In future, added the gRPC-Web support to [Envoy](https://github.com/lyft/envoy). In future,
we expect gRPC-Web to be supported in language-specific Web frameworks, such as we expect gRPC-Web to be supported in language-specific Web frameworks too, such as
Go, Java, Node, which will eliminate the need to deploy a gateway. Go, Java, Node, which will eliminate the need to deploy a gateway.
We expect to ship an alpha version in Q3/2017. Stay tuned! [Sign-up form](https://docs.google.com/forms/d/15iRDHoP-VBenc4hWgKn7bk7IirJLgs0uh88nw1vi_Hc/viewform?edit_requested=true).
For questions, please file an issue or contact varuntalwar@google.com.
## Generate and use the client library ## Generate and use the client library
Please check the end-to-end echo example in [net/grpc/gateway/examples/echo](https://github.com/grpc/grpc-web/tree/master/net/grpc/gateway/examples/echo). Please check the end-to-end echo example in [net/grpc/gateway/examples/echo](https://github.com/grpc/grpc-web/tree/master/net/grpc/gateway/examples/echo).