Skip to content

Commit 429aa80

Browse files
authored
Bumps library version in README (#56)
* Updates library version for setup instructions * Adds CI badges to README * Adds grpcui requirements to docs * Fixes docs for available configs
1 parent c78261e commit 429aa80

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
11
# GrpcReflection
22

3+
[![GitHub CI](https://github.com/elixir-grpc/grpc-reflection/actions/workflows/ci.yml/badge.svg)](https://github.com/elixir-grpc/grpc-reflection/actions/workflows/ci.yml)
4+
[![Hex.pm](https://img.shields.io/hexpm/v/grpc_reflection.svg)](https://hex.pm/packages/grpc_reflection)
5+
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/grpc_reflection/)
6+
[![License](https://img.shields.io/hexpm/l/grpc_reflection.svg)](https://github.com/elixir-grpc/grpc-reflection/blob/main/LICENSE)
7+
[![Total Downloads](https://img.shields.io/hexpm/dt/grpc_reflection.svg)](https://hex.pm/packages/grpc_reflection)
8+
39
Server reflection allows servers to assist clients in runtime construction of requests without having stub information precompiled into the client.
410

511
According to the [GRPC Server Reflection Protocol
612
](https://github.com/grpc/grpc/blob/master/doc/server-reflection.md), the primary usecase for server reflection is to write (typically) command line debugging tools for talking to a grpc server. In particular, such a tool will take in a method and a payload (in human readable text format) send it to the server (typically in binary proto wire format), and then take the response and decode it to text to present to the user.
713

8-
GrpcReflection adds reflection support to a `grpc-elixir` based application. It is a supervised application that can support implemented as a gRPC server using `grpc-elixir`, .
14+
GrpcReflection adds reflection support to applications built with [grpc-elixir](https://hex.pm/packages/grpc). It is a supervised application that can be implemented as a gRPC server using [grpc-elixir](https://github.com/elixir-grpc/grpc).
915

1016
## Installation
1117

1218
The package can be installed by adding `grpc_reflection` to your list of dependencies in `mix.exs`:
1319

1420
```elixir
15-
{:grpc_reflection, "~> 0.1.5"}
21+
{:grpc_reflection, "~> 0.2"}
1622
```
1723

1824
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
@@ -37,10 +43,10 @@ This is written and tested using [grpcurl](https://github.com/fullstorydev/grpcu
3743
end
3844
```
3945

40-
| Config Option | Description |
41-
| ------------- | ---------------------------------------------------------------------- |
42-
| version | Either `:v1` or `:v2` depending on intended client support |
43-
| services | This is a list of GRPC services that should be included for reflection |
46+
| Config Option | Description |
47+
| :---: | --- |
48+
| `version` | Either `:v1` or `:v1alpha`, depending on intended client support. |
49+
| `services` | This is a list of GRPC services that should be included for reflection. |
4450

4551
1. Add the reflection supervisor to your supervision tree to host the cached reflection state
4652

@@ -57,9 +63,9 @@ This is written and tested using [grpcurl](https://github.com/fullstorydev/grpcu
5763
run(Helloworld.Reflection.Server)
5864
```
5965

60-
## interacting with your reflection server
66+
## Interacting with your reflection server
6167

62-
Here are some example `grpcurl` commands and responses excersizing the reflection capabilities
68+
Here are some examples using [grpcurl](https://github.com/fullstorydev/grpcurl) to demonstrate the reflection capabilities:
6369

6470
```shell
6571
$ grpcurl -v -plaintext 127.0.0.1:50051 list
@@ -95,6 +101,7 @@ This module is more thoroughly tested with proto3, but it has some testing with
95101
This is **not** an exhaustive list, contributions are appreciated.
96102

97103
| Application | Reflection version required |
98-
| ----------- | --------------------------- |
99-
| grpcurl | V1 |
100-
| postman | V1alpha |
104+
| --- | :---: |
105+
| [grpcurl](https://github.com/fullstorydev/grpcurl) | V1 |
106+
| [grpcui](https://github.com/fullstorydev/grpcui) | V1 |
107+
| [postman](https://www.postman.com/) | V1alpha |

0 commit comments

Comments
 (0)