README.md in reel-0.6.0.pre5 vs README.md in reel-0.6.0
- old
+ new
@@ -1,11 +1,12 @@
=======
-[](http://rubygems.org/gems/reel)
-[](http://travis-ci.org/celluloid/reel)
-[](https://codeclimate.com/github/celluloid/reel)
-[](https://coveralls.io/r/celluloid/reel)
+[](http://rubygems.org/gems/reel)
+[](http://travis-ci.org/celluloid/reel)
+[](https://codeclimate.com/github/celluloid/reel)
+[](https://coveralls.io/r/celluloid/reel)
+[](https://github.com/celluloid/reel/master/LICENSE.txt)
> "A dizzying lifetime... reeling by on celluloid" _-- Rush / Between The Wheels_
Reel is a fast, non-blocking "evented" web server
built on [http_parser.rb][parser], [websocket_parser][websockets],
@@ -32,38 +33,10 @@
### Is it any good?
[Yes](http://news.ycombinator.com/item?id=3067434)
-Here's a "hello world" web server benchmark, run on a 2GHz i7 (OS X 10.7.3).
-All servers used in a single-threaded mode.
-
-Reel performance on various Ruby VMs:
-
-```
-# httperf --num-conns=50 --num-calls=1000
-
-Ruby Version Throughput Latency
------------- ---------- -------
-JRuby 1.7.0 3978 req/s (0.3 ms/req)
-rbx HEAD 2288 reqs/s (0.4 ms/req)
-Ruby 1.9.3 2071 req/s (0.5 ms/req)
-```
-
-Comparison with other web servers:
-
-```
-Web Server Throughput Latency
----------- ---------- -------
-Goliath (0.9.4) 2058 reqs/s (0.5 ms/req)
-Thin (1.2.11) 7502 reqs/s (0.1 ms/req)
-Node.js (0.6.5) 11735 reqs/s (0.1 ms/req)
-```
-
-All Ruby benchmarks done on Ruby 1.9.3. Latencies given are average-per-request
-and are not amortized across all concurrent requests.
-
Documentation
-------------
[Please see the Reel Wiki](https://github.com/celluloid/reel/wiki)
for detailed documentation and usage notes.
@@ -131,10 +104,11 @@
### Block Form
Reel lets you pass a block to initialize which receives connections:
```ruby
+require 'celluloid/autostart'
require 'reel'
Reel::Server::HTTP.supervise("0.0.0.0", 3000) do |connection|
# Support multiple keep-alive requests per connection
connection.each_request do |request|
@@ -162,10 +136,11 @@
### Subclass Form
You can also subclass Reel, which allows additional customizations:
```ruby
+require 'celluloid/autostart'
require 'reel'
class MyServer < Reel::Server::HTTP
def initialize(host = "127.0.0.1", port = 3000)
super(host, port, &method(:on_connection))
@@ -192,18 +167,26 @@
end
MyServer.run
```
+Supported Ruby Versions
+-----------------------
+
+This library supports and is tested against the following Ruby versions:
+
+* Ruby (MRI) 2.0, 2.1, 2.2, 2.3
+* JRuby 9000
+
Contributing
------------
-* Fork this repository on github
-* Make your changes and send me a pull request
-* If I like them I'll merge them
-* If I've accepted a patch, feel free to ask for commit access
+* Fork this repository on GitHub
+* Make your changes and send us a pull request
+* If we like them we'll merge them
+* If we've accepted a patch, feel free to ask for commit access
License
-------
-Copyright (c) 2012 Tony Arcieri. Distributed under the MIT License. See
+Copyright (c) 2012-2016 Tony Arcieri. Distributed under the MIT License. See
LICENSE.txt for further details.