README.md in eventmachine-le-1.1.0 vs README.md in eventmachine-le-1.1.1
- old
+ new
@@ -1,9 +1,12 @@
-# About EventMachine-LE #
+# EventMachine-LE #
-EventMachine-LE (Live Edition) is a branch of [EventMachine](http://github.com/eventmachine/eventmachine).
+EventMachine-LE (Live Edition) is a branch of [EventMachine](http://github.com/eventmachine/eventmachine) with fixes and more features.
+* Home page: http://ibc.github.com/EventMachine-LE/
+
+
## What do you mean by "branch"? ##
Well, outside the narrower git circles, "fork" has all these negative
connotations, as in bad feelings after an argument, marriages
divorcing, nation states splitting after a civil war, people hating
@@ -32,14 +35,17 @@
EventMachine-LE draws from a number of dormant pull requests on the
mainline version of EventMachine. New proposals will also directly
come to EventMachine-LE and will be included once they are tested.
-This is not a "development branch" — we do intend to use
-EventMachine-LE in production, just beyond the focus of mainline
-EventMachine.
+This is not a "development branch" — we do use EventMachine-LE in production,
+just beyond the focus of mainline EventMachine.
+The intention is that EventMachine-LE is always a drop-in replacement
+for EventMachine, just with additional (and fixed) functionality.
+
+
## Features and changes ##
The list of additions and improvements will grow over time. Currently
the following features/fixes have been applied in EventMachine-LE:
@@ -48,17 +54,18 @@
* `EM::attach_server` added ([ramonmaruko](https://github.com/eventmachine/eventmachine/pull/271)).
* `EM::RestartableTimer` added ([adzap](https://github.com/eventmachine/eventmachine/pull/114)).
* `EM::get_max_timers` and `EM::set_max_timers` are removed (they still exist but do nothing). This solves the annoying "RuntimeError: max timers exceeded" exception.
* Support for Enumerable in `EM::Iterator` ([fl00r](https://github.com/eventmachine/eventmachine/pull/300)).
* Improvements to `EM::Protocols::LineProtocol` and have it autoload ([gaffneyc](https://github.com/eventmachine/eventmachine/pull/151)).
-* `EM::Protocols::SmtpServer`: support multiple messages per one connection ([bogdan](https://github.com/eventmachine/eventmachine/pull/288)).
+* `EM::Protocols::SmtpServer`: support multiple messages per one connection and login auth type ([bogdan](https://github.com/eventmachine/eventmachine/pull/288)).
+* Reimplement `EM::Queue` to avoid shift/push performance problem ([grddev](https://github.com/eventmachine/eventmachine/pull/311)).
* Many code cleanups.
## Installation ##
-Install the Ruby Gem:
+The Current stable version is eventmachine-le-1.1.0 (published as Ruby Gem), installable via:
<pre>
gem install eventmachine-le
</pre>
If you want the beta version (not fully tested) install it by using `--pre` option:
@@ -67,14 +74,19 @@
</pre>
## Usage ##
-In order to use this branch in your project, make sure you load it as follows:
+Using EventMachine-LE within your project just requires loading it as follows:
<pre>
# First load EventMachine-LE.
require "eventmachine-le"
-# Later load any other Ruby Gem depending on EventMachine so they will use EventMachine-LE.
+
+# NOTE: It does not hurt to call "require 'eventmachine'" later
+# (it has no effect at all).
+
+# Then load any other Ruby Gem depending on EventMachine so it
+# will use EventMachine-LE.
require "em-udns"
</pre>
By doing this, you will avoid conflicts with the main EventMachine Gem (if it's also installed).