better readme for realtime server
This commit is contained in:
parent
fe76f340a0
commit
c2a2fe4997
2 changed files with 19 additions and 1 deletions
|
@ -1 +1,18 @@
|
|||
'Real-Time'
|
||||
## Node.js realtime server
|
||||
|
||||
To run the server, you need to install the dependencies and run the server.
|
||||
Please ensure you have followed the OS-specific instructions in doc/ to
|
||||
install NodeJS. Once you have node, then you can proceed to install the
|
||||
node packages for the realtime server:
|
||||
|
||||
cd realtime
|
||||
npm install #creates node_modules directory
|
||||
node realtime-server.js
|
||||
|
||||
That's it!
|
||||
|
||||
To run the server as a daemon that will be re-run if it crashes, you can
|
||||
use the forever node package.
|
||||
|
||||
sudo npm install -g forever
|
||||
forever start realtime-server.js
|
||||
|
|
|
@ -2,6 +2,7 @@
|
|||
"name": "RoR-real-time",
|
||||
"description": "providing real-time sychronization for ruby on rails",
|
||||
"version": "0.0.1",
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
"socket.io": "0.9.12"
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue