diff --git a/README.md b/README.md index f8946445..8be8a51b 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ [![GitHub CI](https://github.com/elixir-grpc/grpc/actions/workflows/ci.yml/badge.svg)](https://github.com/elixir-grpc/grpc/actions/workflows/ci.yml) [![Hex.pm](https://img.shields.io/hexpm/v/grpc.svg)](https://hex.pm/packages/grpc) [![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/grpc/) -[![License](https://img.shields.io/hexpm/l/grpc.svg)](https://github.com/elixir-grpc/grpc/blob/master/LICENSE.md) -[![Total Download](https://img.shields.io/hexpm/dt/grpc.svg)](https://hex.pm/packages/elixir-grpc/grpc) +[![License](https://img.shields.io/hexpm/l/grpc.svg)](https://github.com/elixir-grpc/grpc/blob/master/LICENSE) +[![Total Downloads](https://img.shields.io/hexpm/dt/grpc.svg)](https://hex.pm/packages/grpc) [![Last Updated](https://img.shields.io/github/last-commit/elixir-grpc/grpc.svg)](https://github.com/elixir-grpc/grpc/commits/master) **gRPC Elixir** is a full-featured Elixir implementation of the [gRPC](https://grpc.io) protocol, supporting unary and streaming RPCs, interceptors, HTTP transcoding, and TLS. This version adopts a unified stream-based model for all types of calls. @@ -34,7 +34,7 @@ def deps do [ {:grpc, "~> 0.10"}, {:protobuf, "~> 0.14"}, # optional for import wellknown google types - {:grpc_reflection, "~> 0.1"} # optional enable grpc reflection + {:grpc_reflection, "~> 0.2"} # optional enable grpc reflection ] end ``` @@ -150,8 +150,8 @@ defmodule Helloworld.Application do GrpcReflection, { GRPC.Server.Supervisor, [ - endpoint: Helloworld.Endpoint, - port: 50051, + endpoint: Helloworld.Endpoint, + port: 50051, start_server: true, # adapter_opts: [# any adapter-specific options like tls configuration....] ] @@ -162,7 +162,7 @@ defmodule Helloworld.Application do Supervisor.start_link(children, opts) end end -``` +``` # Client Usage @@ -234,8 +234,8 @@ In mix.exs: ```elixir def deps do [ - {:grpc, "~> 0.7"}, - {:protobuf_generate, "~> 0.1.1"} + {:grpc, "~> 0.10"}, + {:protobuf_generate, "~> 0.1.3"} ] end ``` @@ -268,7 +268,7 @@ See full application code in [helloworld_transcoding](examples/helloworld_transc ### **CORS** -When accessing gRPC from a browser via HTTP transcoding or gRPC-Web, CORS headers may be required for the browser to allow access to the gRPC endpoint. Adding CORS headers can be done by using `GRPC.Server.Interceptors.CORS` as an interceptor in your `GRPC.Endpoint` module, configuring it as decribed in the module documentation: +When accessing gRPC from a browser via HTTP transcoding or gRPC-Web, CORS headers may be required for the browser to allow access to the gRPC endpoint. Adding CORS headers can be done by using `GRPC.Server.Interceptors.CORS` as an interceptor in your `GRPC.Endpoint` module, configuring it as described in the module documentation: Example: @@ -292,10 +292,10 @@ end - [Bidirectional-streaming](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc) - [HTTP Transcoding](https://cloud.google.com/endpoints/docs/grpc/transcoding) - [TLS Authentication](https://grpc.io/docs/guides/auth/#supported-auth-mechanisms) -- [Error handling](https://grpc.io/docs/guides/error/) -- [Interceptors](`GRPC.Endpoint`) +- [Error Handling](https://grpc.io/docs/guides/error/) +- [Interceptors](https://grpc.io/docs/guides/interceptors/) - [Connection Backoff](https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md) -- Data compression +- [Data Compression](https://grpc.io/docs/guides/compression/) - [gRPC Reflection](https://github.com/elixir-grpc/grpc-reflection) ## Benchmark