README.md in posix-mqueue-0.0.7 vs README.md in posix-mqueue-0.0.8
- old
+ new
@@ -1,20 +1,28 @@
-# posix-mqueue
+# posix-mqueue [](https://travis-ci.org/Sirupsen/posix-mqueue)
Minimal wrapper around the [POSIX message queue](pmq). The POSIX message queue
offers:
* Persistence. Push messages while nothing is listening.
* Simplicity. Nothing to set up. Built into Linux.
* IPC. Blazingly fast communication between processes on the same machine.
* Blocking and non-blocking. Listeners block until a message arrives on the
queue. No polling. Sending messages doesn't block.
-Add `gem 'posix-mqueue', :git => "git@github.com:Sirupsen/posix-mqueue.git"` to your favorite Gemfile.
+Note that this requires no third party message broker. The messages are handled
+by the kernel of your computer. Not all kernels have support for POSIX message
+queues, a notably example is Darwin (OS X). Darwin implements the older System V
+IPC API. See my [SysV MQ wrapper](https://github.com/Sirupsen/sysvmq).
+
## Usage
+In your Gemfile:
+
+`gem 'posix-mqueue'`
+
### Important notes
1. This will not work on OS X, but on Linux and probably BSD (not tested).
2. `send` and `receive` block. `timedsend` and `timedreceive` do not.
3. The default message size is `4096` bytes.
@@ -47,10 +55,10 @@
# #size returns the size of the queue
m.size
# => 10
-# #send will block until something is popped off the now full queue.
+# #send will block until something is popped off the now full queue.
# timesend takes timeout arguments (first one is seconds, second is
# nanoseconds). Pass 0 for for both to not block, this is default.
assert_raises POSIX::Mqueue::QueueFull do
m.timedsend "I will fail"