README.md in zmachine-0.2.0 vs README.md in zmachine-0.2.1
- old
+ new
@@ -1,11 +1,15 @@
-# Zmachine
+# ZMachine
-ZMachine is a JRuby Event Reactor based on java.nio.Selector and a HashedWheel
-timer implementation. ZMachine supports TCP and ZeroMQ sockets natively and
-exposes an EventMachine compatible API where possible.
+ZMachine is a pure JRuby multi-threaded event loop based on java.nio.Selector
+and a hashed wheel timer implementation. ZMachine supports TCP and ZeroMQ
+sockets natively and exposes an EventMachine compatible API where possible.
+[![Build Status](https://travis-ci.org/liquidm/zmachine.png)](https://travis-ci.org/liquidm/zmachine)
+[![Code Climate](https://codeclimate.com/github/liquidm/zmachine.png)](https://codeclimate.com/github/liquidm/zmachine)
+[![Dependency Status](https://gemnasium.com/liquidm/zmachine.png)](https://gemnasium.com/liquidm/zmachine)
+
## Installation
Add this line to your application's Gemfile:
gem 'zmachine'
@@ -18,10 +22,11 @@
$ gem install zmachine
## Usage
-TODO: Write usage instructions here
+ZMachine is mostly API compatible with EventMachine. Replace `EM` /
+`EventMachine` with `ZMachine` in your code and it should work out of the box.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)