Permalink
Browse files

Rearranged text to fit a bit better in github :P and yes, I'm too laz…

…y to make it rdoc.
  • Loading branch information...
jcwilk committed May 16, 2011
1 parent e8b1600 commit 095840eef3c2f809f20b341cbb5c697c21a17690
Showing with 14 additions and 10 deletions.
  1. +14 −10 README
View
24 README
@@ -1,16 +1,20 @@
Push server in Node.js
-The purpose of this project is to make a very lightweight, flexible, easy to understand messaging server for getting data broadcasted
-to in-browser flash-free websockets-free javascript-only clients in real time using long-poll.
+The purpose of this project is to make a very lightweight, flexible, easy to understand messaging server for getting
+data broadcasted to in-browser flash-free websockets-free javascript-only clients in real time using long-poll.
-The advantage of this approach rather than using flash or websockets is that it maximizes your compatibility, makes all of your clients
-behave the same way, and if your application can be optimized for the slightly jerky behavior of long poll it can be a very good option.
+The advantage of this approach rather than using flash or websockets is that it maximizes your compatibility, makes
+all of your clients behave the same way, and if your application can be optimized for the slightly jerky behavior of
+long poll it can be a very good option.
-The way it works is the push.js file which is used by the client page is passed via javascripts some channels to listen on.
-For each of these channels, a connection is made to /m/channel-name.json?s=50 with a GET.
-If there is new data on that channel since sequence 50, it is immediately returned.
-If sequence 50 indicates the client is up to date with the most current data, then the connection is added to the listener pool and the client waits for the request to return
+Whenever the client webpage wants to listen for data...
+-The push.js file which is used by the client page is passed via javascripts some channels to listen on
+-For each of these channels, a connection is made to /m/channel-name.json?s=50 with a GET
+-If there is new data on that channel since sequence 50, it is immediately returned
+-If sequence 50 indicates the client is up to date with the most current data, then the connection is added to the
+listener pool and the client waits for the request to return
Whenever the server wants to broadcast messages...
-The application server posts data to /m/channel-name.json
-The push server appends the data to the channel and triggers any listener's callbacks which are waiting for data on that channel
+-The application server posts data to /m/channel-name.json
+-The push server appends the data to the channel and triggers any listener's callbacks which are waiting for data
+on that channel

0 comments on commit 095840e

Please sign in to comment.