Skip to content

Commit 0102b97

Browse files
authored
Fixes broken links for CI badges (#433)
* Fixes links for README badges * Updates lib versions in Examples sections * Auto-formats README
1 parent faee2c1 commit 0102b97

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
[![GitHub CI](https://github.com/elixir-grpc/grpc/actions/workflows/ci.yml/badge.svg)](https://github.com/elixir-grpc/grpc/actions/workflows/ci.yml)
44
[![Hex.pm](https://img.shields.io/hexpm/v/grpc.svg)](https://hex.pm/packages/grpc)
55
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/grpc/)
6-
[![License](https://img.shields.io/hexpm/l/grpc.svg)](https://github.com/elixir-grpc/grpc/blob/master/LICENSE.md)
7-
[![Total Download](https://img.shields.io/hexpm/dt/grpc.svg)](https://hex.pm/packages/elixir-grpc/grpc)
6+
[![License](https://img.shields.io/hexpm/l/grpc.svg)](https://github.com/elixir-grpc/grpc/blob/master/LICENSE)
7+
[![Total Downloads](https://img.shields.io/hexpm/dt/grpc.svg)](https://hex.pm/packages/grpc)
88
[![Last Updated](https://img.shields.io/github/last-commit/elixir-grpc/grpc.svg)](https://github.com/elixir-grpc/grpc/commits/master)
99

1010
**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
3434
[
3535
{:grpc, "~> 0.10"},
3636
{:protobuf, "~> 0.14"}, # optional for import wellknown google types
37-
{:grpc_reflection, "~> 0.1"} # optional enable grpc reflection
37+
{:grpc_reflection, "~> 0.2"} # optional enable grpc reflection
3838
]
3939
end
4040
```
@@ -150,8 +150,8 @@ defmodule Helloworld.Application do
150150
GrpcReflection,
151151
{
152152
GRPC.Server.Supervisor, [
153-
endpoint: Helloworld.Endpoint,
154-
port: 50051,
153+
endpoint: Helloworld.Endpoint,
154+
port: 50051,
155155
start_server: true,
156156
# adapter_opts: [# any adapter-specific options like tls configuration....]
157157
]
@@ -162,7 +162,7 @@ defmodule Helloworld.Application do
162162
Supervisor.start_link(children, opts)
163163
end
164164
end
165-
```
165+
```
166166

167167
# Client Usage
168168

@@ -234,8 +234,8 @@ In mix.exs:
234234
```elixir
235235
def deps do
236236
[
237-
{:grpc, "~> 0.7"},
238-
{:protobuf_generate, "~> 0.1.1"}
237+
{:grpc, "~> 0.10"},
238+
{:protobuf_generate, "~> 0.1.3"}
239239
]
240240
end
241241
```
@@ -268,7 +268,7 @@ See full application code in [helloworld_transcoding](examples/helloworld_transc
268268

269269
### **CORS**
270270

271-
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:
271+
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:
272272

273273
Example:
274274

@@ -292,10 +292,10 @@ end
292292
- [Bidirectional-streaming](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc)
293293
- [HTTP Transcoding](https://cloud.google.com/endpoints/docs/grpc/transcoding)
294294
- [TLS Authentication](https://grpc.io/docs/guides/auth/#supported-auth-mechanisms)
295-
- [Error handling](https://grpc.io/docs/guides/error/)
296-
- [Interceptors](`GRPC.Endpoint`)
295+
- [Error Handling](https://grpc.io/docs/guides/error/)
296+
- [Interceptors](https://grpc.io/docs/guides/interceptors/)
297297
- [Connection Backoff](https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md)
298-
- Data compression
298+
- [Data Compression](https://grpc.io/docs/guides/compression/)
299299
- [gRPC Reflection](https://github.com/elixir-grpc/grpc-reflection)
300300

301301
## Benchmark

0 commit comments

Comments
 (0)