Fixes the grpc.gemspec, clarifies the installation instructions

pull/615/head
Tim Emiola 10 years ago
parent 50b91d0018
commit c33efe4ad5
  1. 25
      src/ruby/README.md
  2. 8
      src/ruby/grpc.gemspec

@ -1,7 +1,7 @@
gRPC Ruby
=========
A Ruby implementation of gRPC, Google's RPC library.
A Ruby implementation of gRPC.
INSTALLATION PREREQUISITES
@ -10,29 +10,30 @@ INSTALLATION PREREQUISITES
This requires Ruby 2.x, as the rpc api surface uses keyword args.
INSTALLING
----------
QUICK - INSTALL
---------------
- Install the gRPC core library
TODO: describe this, once the core distribution mechanism is defined.
- Clone this repository.
- Follow the instructions in the [INSTALL](../../INSTALL) to install grpc C core library.
- Use bundler to install
```sh
$ # from this directory
$ gem install bundler && bundle install
```
$ gem install grpc
```
Installing from source
----------------------
- Build or Install the gRPC core
E.g, from the root of the grpc [git repo](https://github.com/google/grpc)
```
```sh
$ cd ../..
$ make && sudo make install
```
- Install Ruby 2.x. Consider doing this with [RVM](http://rvm.io), it's a nice way of controlling
the exact ruby version that's used.
```
```sh
$ command curl -sSL https://rvm.io/mpapis.asc | gpg --import -
$ \curl -sSL https://get.rvm.io | bash -s stable --ruby
$
@ -46,7 +47,7 @@ $ gem install bundler
```
- Finally, install grpc ruby locally.
```
```sh
$ cd <install_dir>
$ bundle install
$ rake # compiles the extension, runs the unit tests, see rake -T for other options
@ -69,6 +70,6 @@ Directory structure is the layout for [ruby extensions](http://guides.rubygems.o
stub = Math::Math::Stub.new('my.test.math.server.com:8080')
req = Math::DivArgs.new(dividend: 7, divisor: 3)
logger.info("div(7/3): req=#{req.inspect}")
resp = stub.div(req, INFINITE_FUTURE)
resp = stub.div(req)
logger.info("Answer: #{resp.inspect}")
```

@ -5,12 +5,12 @@ require 'grpc/version'
Gem::Specification.new do |s|
s.name = 'grpc'
s.version = Google::RPC::VERSION
s.version = GRPC::VERSION
s.authors = ['gRPC Authors']
s.email = 'tbetbetbe@gmail.com'
s.email = 'temiola@google.com'
s.homepage = 'https://github.com/google/grpc/tree/master/src/ruby'
s.summary = 'Google RPC system in Ruby'
s.description = 'Send RPCs from Ruby using Google\'s RPC system'
s.summary = 'GRPC system in Ruby'
s.description = 'Send RPCs from Ruby using GRPC'
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- spec/*`.split("\n")

Loading…
Cancel
Save