README.md in celluloid-zmq-0.17.0 vs README.md in celluloid-zmq-0.17.2

- old
+ new

@@ -3,15 +3,15 @@ [![Gem Version](https://badge.fury.io/rb/celluloid-zmq.png)](http://rubygems.org/gems/celluloid-zmq) [![Build Status](https://secure.travis-ci.org/celluloid/celluloid-zmq.png?branch=master)](http://travis-ci.org/celluloid/celluloid-zmq) [![Code Climate](https://codeclimate.com/github/celluloid/celluloid-zmq.png)](https://codeclimate.com/github/celluloid/celluloid-zmq) [![Coverage Status](https://coveralls.io/repos/celluloid/celluloid-zmq/badge.png?branch=master)](https://coveralls.io/r/celluloid/celluloid-zmq) -Celluloid::ZMQ provides Celluloid actors that can interact with [0MQ sockets][0mq]. -Underneath, it's built on the [ffi-rzmq][ffi-rzmq] library. Celluloid::ZMQ was +`Celluloid::ZMQ` provides Celluloid actors that can interact with [0MQ sockets][0mq]. +Underneath, it's built on the [ffi-rzmq][ffi-rzmq] library. `Celluloid::ZMQ` was primarily created for the purpose of writing [DCell][dcell], distributed Celluloid over 0MQ, so before you go building your own distributed Celluloid systems with -Celluloid::ZMQ, be sure to give DCell a look and decide if it fits your purposes. +`Celluloid::ZMQ`, be sure to give DCell a look and decide if it fits your purposes. [0mq]: http://www.zeromq.org/ [ffi-rzmq]: https://github.com/chuckremes/ffi-rzmq [dcell]: https://github.com/celluloid/dcell @@ -29,17 +29,18 @@ To use JRuby in 1.9 mode, you'll need to pass the "--1.9" command line option to the JRuby executable, or set the "JRUBY_OPTS=--1.9" environment variable. ## 0MQ Socket Types -The following 0MQ socket types are supported (see [sockets.rb][socketsrb] for more info) +The following 0MQ socket types are supported (see [types.rb][types] for more info) -[socketsrb]: https://github.com/celluloid/celluloid-zmq/blob/master/lib/celluloid/zmq/sockets.rb +[types]: https://github.com/celluloid/celluloid-zmq/blob/master/lib/celluloid/zmq/socket/types.rb -* ReqSocket / RepSocket -* PushSocket / PullSocket -* PubSocket / SubSocket +* Req / Rep +* Push / Pull +* Pub / Sub +* Dealer / Router ## Usage ```ruby require 'celluloid/zmq' @@ -48,11 +49,11 @@ class Server include Celluloid::ZMQ def initialize(address) - @socket = PullSocket.new + @socket = Socket::Pull.new begin @socket.bind(address) rescue IOError @socket.close @@ -71,11 +72,11 @@ class Client include Celluloid::ZMQ def initialize(address) - @socket = PushSocket.new + @socket = Socket::Push.new begin @socket.connect(address) rescue IOError @socket.close @@ -102,6 +103,8 @@ ``` Copyright --------- -Copyright (c) 2014 Tony Arcieri. See LICENSE.txt for further details. +Copyright (c) 2014-2015 Tony Arcieri, Donovan Keme. + +Distributed under the MIT License. See [LICENSE.txt](https://github.com/celluloid/celluloid/blob/master/LICENSE.txt) for further details.