README.md in jubilee-0.5.0 vs README.md in jubilee-1.0.0.beta1
- old
+ new
@@ -1,11 +1,11 @@
[](https://travis-ci.org/isaiah/jubilee)
Jubilee
=========
-A fast rack server build upon [vertx 2.0](http://vertx.io).
+An rack server with [vertx 2.0](http://vertx.io) built in.
Why another rack server?
------------------------
"Vert.x is a lightweight, high performance application platform for the JVM
@@ -14,32 +14,77 @@
In short, Vertx is nodejs on the JVM, only much more faster, checkout the awesome
[benchmarks](http://vertxproject.wordpress.com/2012/05/09/vert-x-vs-node-js-simple-http-benchmarks/)
By using Vertx, jubilee inherent advantages in terms of performance, and all
-the [other cool features of Vertx](#roadmap).
+the other cool features of Vertx:
+* [EventBus](https://github.com/isaiah/jubilee/wiki/Event-Bus)
+* [SharedData](https://github.com/isaiah/jubilee/wiki/SharedData)
+* [Clustering](https://github.com/isaiah/jubilee/wiki/Clustering)
+
+
+
Installation
------------
+------------
-```gem install jubilee```
+ $ jruby -S gem install jubilee
+Jubilee requires JRuby 1.7.0 or later, and JDK 7+
-Roadmap
+Get started
-----------
- Eventbus support
+ $ cd a-rack-app
+ $ jruby -S jubilee
- Shared data
+Setup
+-----
- Clustering
+If you use bundler, you might want to add `jubilee` to your Gemfile
-Requirements
-------------
+ $ jubilee
-Java7 or above
+or if you prefer to use the rack handler(e.g. development) use:
-JRuby '~> 1.7.0'
+ $ rails s jubilee
+
+or
+
+ $ rackup -s jubilee
+
+Event Bus
+=========
+
+Event Bus is a pub/sub mechanism, it can be used from server to server, server
+to client and client to client, with the same API!
+
+Examples
+--------
+
+Assume necessary javascript files are loaded in the page, start jubilee in a
+rack application with:
+
+```
+$ jubilee --eventbus /eventbus
+```
+
+In one browser:
+
+```javascript
+JubileeEventBus = new vertx.EventBus("http://localhost:3215/eventbus");
+JubileeEventBus.registerHandler("test", function(data){
+ console.info(data);
+});
+
+```
+
+In another:
+
+```javascript
+JubileeEventBus = new vertx.EventBus("http://localhost:3215/eventbus");
+JubileeEventBus.send("test", "hello, world");
+```
License
--------
The same as JRuby and vertx