From c2a2fe4997ce0406b4746c44dc62e75122ba6580 Mon Sep 17 00:00:00 2001
From: Devin Howard <devin@callysto.com>
Date: Sun, 17 Jan 2016 10:14:19 +0800
Subject: [PATCH] better readme for realtime server

---
 realtime/README.md    | 19 ++++++++++++++++++-
 realtime/package.json |  1 +
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/realtime/README.md b/realtime/README.md
index 468f526e..5c81979b 100644
--- a/realtime/README.md
+++ b/realtime/README.md
@@ -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
diff --git a/realtime/package.json b/realtime/package.json
index 1a11284a..0bedc1c4 100644
--- a/realtime/package.json
+++ b/realtime/package.json
@@ -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"
   }