From b16f65b72b910ffce5f26036c6c14d2ffc9dd84b Mon Sep 17 00:00:00 2001 From: Mattias Erming Date: Wed, 13 Aug 2014 03:27:53 +0200 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++---------------------- 1 file changed, 10 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 9ead3e9..da5dc0e 100644 --- a/README.md +++ b/README.md @@ -4,35 +4,23 @@ Run your IRC client on a server and access it from the web browser. This allows ### [Try the Shout client](http://shout-irc.com:9090/) -_Some highlights:_ - -- [x] Multiple user support -- [x] Supports anonymous (public) or passworded connections -- [x] Works on your smartphone - -## Screenshot - -![](https://raw.github.com/erming/shout/master/screenshots/shout.png) - ## Install -1. Install Node.js and npm -`sudo apt-get install nodejs-legacy npm` +``` +sudo npm install -g shout +``` -2. Clone the project from GitHub -`git clone http://github.com/erming/shout` +## Usage -3. Open folder -`cd shout/` +When the install is complete, go ahead and start the server: -4. Install packages -`sudo npm install --production` +``` +shout start --port 9000 +``` -5. Run the server -`npm start` or `node index.js` +## Screenshots -6. Open your browser -`http://localhost:9000` +![](https://raw.github.com/erming/shout/master/screenshots/shout.png) ### Commands