Skip to content

Commit

Permalink
Merge pull request grpc-ecosystem#222 from sdemos/readme-update
Browse files Browse the repository at this point in the history
readme: added links to additional documentation
  • Loading branch information
yugui authored Sep 13, 2016
2 parents 45e6bd8 + c645fde commit 865c0a0
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
grpc-gateway is a plugin of [protoc](http://github.com/google/protobuf).
It reads [gRPC](http://github.com/grpc/grpc-common) service definition,
and generates a reverse-proxy server which translates a RESTful JSON API into gRPC.
This server is generated according to [custom options](https://cloud.google.com/service-management/reference/rpc/google.api#http) in your gRPC definition.

It helps you to provide your APIs in both gRPC and RESTful style at the same time.

Expand Down Expand Up @@ -60,7 +61,7 @@ Make sure that your `$GOPATH/bin` is in your `$PATH`.
rpc Echo(StringMessage) returns (StringMessage) {}
}
```
2. Add a custom option to the .proto file
2. Add a [custom option](https://cloud.google.com/service-management/reference/rpc/google.api#http) to the .proto file

your_service.proto:
```diff
Expand Down

0 comments on commit 865c0a0

Please sign in to comment.