Skip to content

Commit

Permalink
more readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
carlhoerberg committed Apr 8, 2012
1 parent e6abdac commit af0c0f7
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Expand Up @@ -3,8 +3,6 @@ Meerkat

Rack middleware for [Server-Sent Events (HTML5 SSE)](http://www.html5rocks.com/en/tutorials/eventsource/basics/).

Requires an [EventMachine](https://github.com/eventmachine/eventmachine#readme) backed server, like [Thin](http://code.macournoyer.com/thin/) or [Rainbows](http://rainbows.rubyforge.org/) (with the EventMachine backend only).

Features:

* Realtime events
Expand All @@ -31,7 +29,7 @@ Supported backends:
Usage
-----

Put meerkat and pg or em-hiredis in your Gemfile, depending on which backend you plan to use.
Put meerkat and amqp, pg or em-hiredis in your Gemfile, depending on which backend you plan to use.
Gemfile:

```ruby
Expand All @@ -42,8 +40,11 @@ gem 'pg'
# or
gem 'em-hiredis'
```

Require meerkat and the backend you would like to use.

Meerkat is based on [EventMachine ](http://rubyeventmachine.com/) and thus requires [Thin](http://code.macournoyer.com/thin/) or [Rainbows](http://rainbows.rubyforge.org/) (with the EventMachine backend) as web server.

config.ru:

```ruby
Expand All @@ -62,6 +63,7 @@ Meerkat.backend = Meerkat::Backend::AMQP.new 'amqp://guest:guest@localhost'
map '/' do
run App
end

map '/stream' do
run Meerkat::RackAdapter.new
end
Expand Down

0 comments on commit af0c0f7

Please sign in to comment.