From 47c668bb74c572d3191c347e81848df6d1ee0d35 Mon Sep 17 00:00:00 2001 From: Mattias Erming Date: Sun, 20 Apr 2014 14:53:55 +0200 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c81f2561..2f52a0bd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -__Work in progress.__ - ## Chat Run your IRC client on a server and access it from the web browser. This gives you a persistent connection and allows you to chat from multiple devices at the same time. @@ -22,3 +20,23 @@ These are the commands currently implemented: - `/topic` - `/voice` - `/whois` + +## Install + +1. Install Node.js and NPM +`sudo apt-get -y install nodejs npm` + +2. Clone the project from GitHub +`git clone --recursive http://github.com/erming/chat` + +3. Open folder +`cd chat/` + +4. Install Node packages +`npm install` + +5. Run the server +`npm start` or `nodejs index.js` + +6. Open your browser +`http://localhost:9000`