Skip to content

Commit

Permalink
Cleaning up the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
leppert committed Nov 10, 2011
1 parent cfad238 commit e30387e
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Original file line Diff line number Diff line change
@@ -1,6 +1,6 @@
Reading Message Server (RMSN) Reading Message Server (RMSN)
============================= =============================
Built for and currently powering [Reading.am](http://reading.am). Built for [Reading.am](http://reading.am).
Intended as a drop-in replacement for [Pusher](http://pusher.com), Intended as a drop-in replacement for [Pusher](http://pusher.com),
specifically on [Heroku](http://www.heroku.com) but generally anywhere. specifically on [Heroku](http://www.heroku.com) but generally anywhere.
Kept afloat by [now.js](http://nowjs.com) on top of [node.js](http://nodejs.org). Kept afloat by [now.js](http://nowjs.com) on top of [node.js](http://nodejs.org).
Expand Down Expand Up @@ -72,10 +72,13 @@ Don't see your feature supported? Send a pull request!


Publisher Libraries Publisher Libraries
------------------- -------------------
###Ruby Gem RMSN works with most of the standard [Pusher publisher libraries](http://pusher.com/docs/rest_libraries).
RMSN works with the standard [Pusher Gem](https://github.com/pusher/pusher-gem). Simply specify your RMSN server in place of the Pusher's `api.pusherapp.com`
Simply install it as you would normally but when configuring, use the [URL and the rest should take care of itself. Library specific are details below
method](https://github.com/pusher/pusher-gem/blob/master/lib/pusher.rb#L50) with `rmsn.example.com` as an example RMSN server endpoint. You knew that.

###[Ruby](https://github.com/pusher/pusher-gem)
Config that Ruby gem using the [URL method](https://github.com/pusher/pusher-gem/blob/master/lib/pusher.rb#L50)
with this scheme: with this scheme:


http://KEY:SECRET@rmsn.example.com/apps/APP_ID http://KEY:SECRET@rmsn.example.com/apps/APP_ID
Expand All @@ -88,6 +91,11 @@ Rails application might look like this:
If you're using Heroku, make sure to remove the Pusher add-on, otherwise If you're using Heroku, make sure to remove the Pusher add-on, otherwise
your configuration will more than likely be overwritten upon deployment. your configuration will more than likely be overwritten upon deployment.


###[PHP](https://github.com/squeeks/Pusher-PHP)
Specify your host like so:

$pusher = new Pusher($key, $secret, $app_id, $debug, 'http://rmsn.example.com');

Deploying to Heroku Deploying to Heroku
------------------- -------------------


Expand Down

0 comments on commit e30387e

Please sign in to comment.