Skip to content

Commit

Permalink
Making README.dm more consumable. Making it more readable as a tutori…
Browse files Browse the repository at this point in the history
…al. Added TODOs section. Cleaned up some malappropriate formatting for GFMarkdown.
  • Loading branch information
benzenwen committed Mar 12, 2012
1 parent 187184d commit 29959b8
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions README.md
@@ -1,22 +1,36 @@
#Tractor Push
This is a demonstration of a socket.io client that accepts two message streams from a server asynchronously. The left box updates on the arrival of the 'all messages' stream: simple, array, or complex. The right box updates from a message stream of only 'complex' type. The streams are independent but draw from the same source.
# Tractor Push
This is a demonstration of a socket.io client that accepts two message streams from a server asynchronously. The left box updates on the arrival of the 'all messages' stream: simple, array, or complex. The right box updates from a message stream of only 'complex' type. The streams are independent but draw from the same source.

The server is node.js running socket.io. It reads from a capped MongoDB database with a tailable cursor. A secondary set of servers (it happens to be in Ruby) originally wrote to the database.
The server is node.js running socket.io. It reads from a capped MongoDB database with a tailable cursor. A secondary set of servers (it happens to be in Ruby) originally wrote to the database.

# HOWTO
See: (TODO: URL) for detailed instructions on how to run the demo, but succintly:
* Create a mongodb database 'testdatabase' with a capped collection 'messages' on localhost OR use Heroku and create a MONGOLAB database.
* Run tractorpush-inserter to insert files TODO NEED URL
* Run 'npm install' Run tractorpush-server (this project): 'node.js app.js'
* Point your browser to http://localhost:2000 and enjoy

# REQUIRES (ok, it may run with something less)
* Node.js 0.6.9 +
* npm 1.1.0-3
* see package.json for more dependencies (socket.io and mongodb)

Note: Sequence numbers may not be unique.

The node.js and Ruby components are running on Heroku's Celedon Cedar stack. The MongoDB database is hosted at MongoLab. See this URL 'TODO: add URL' for more information.

# TODO
* Make this demo more obvious what to do if a newbie (or a pointer to the blog entry).
* Make this demo server insert one document if it finds a blank database (which means creating a capped collection.) or at least send a reasonable message to the user somehow.

Original Demo: 2012 March

## Legal stuff
Copyright 2012 ObjectLabs Corporation.

Code licensed underthe Apache License, Version 2.0 (the "Apache
License"); you may not use this file except in compliance with
the Apache License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0
the Apache License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the Apache License is distributed on an "AS IS"
Expand Down

0 comments on commit 29959b8

Please sign in to comment.