Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updating README.md.

  • Loading branch information...
commit 847ac92bcaa8dba1b63b2907787b83796f0b208b 1 parent e4b8003
@joshmarshall authored
Showing with 31 additions and 0 deletions.
  1. +31 −0 README.md
View
31 README.md
@@ -3,3 +3,34 @@ UberChat
This is just an early experiment with Node.JS + Socket.IO.
You can play with a live example at chat.joshmarshall.org.
+
+There isn't a datastore / persistence layer yet. That may
+be coming... but it's a goofy little project, so don't hold
+your breath. :)
+
+Requirements
+------------
+* Node.JS (http://node.js)
+* NPM (if you install packages using it :))
+* Socket.IO (npm install socket.io)
+* Express (npm install express)
+* EJS (npm install ejs)
+
+Running
+-------
+Just a node app, so:
+
+ node app.js
+ NODE_ENV=production node app.js
+
+etc., work like normal.
+
+Configuration
+-------------
+The default configuration options are in config.js, but
+I recommend creating "development.js" or "production.js"
+files in the main root instead of jacking with config.js,
+unless you want to make changes to every installation.
+
+These will be automatically used based on the contents
+of "NODE_ENV"

0 comments on commit 847ac92

Please sign in to comment.
Something went wrong with that request. Please try again.