diff --git a/ruby/README.md b/ruby/README.md index 668baf3eb71..1fc19a4f246 100644 --- a/ruby/README.md +++ b/ruby/README.md @@ -1,26 +1,26 @@ -gRPC Ruby Helloworld -==================== +gRPC in 3 minutes (Ruby) +======================== -INSTALLATION PREREQUISITES --------------------------- +PREREQUISITES +------------- -This requires Ruby 2.x, as the gRPC API surface uses keyword args. +This requires Ruby 2.1, as the gRPC API surface uses keyword args. INSTALL ------- - Clone this repository. - Follow the instructions in [INSTALL](https://github.com/grpc/grpc/blob/master/INSTALL) to install the gRPC C core. -- *Temporary* Install gRPC for Ruby from source on your local machine and update path: to refer to it [Gemfile]. - - this is needed until the gRPC ruby gem is published +- *Temporary* Install the full gRPC distribution from source on your local machine and update path: in [Gemfile] to refer src/ruby within it. + - this is necessary until the gRPC ruby gem is published - Use bundler to install ```sh $ # from this directory $ gem install bundler && bundle install ``` -USAGE ------ +Try it! +------- - Run the server ```sh