X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=README.md;h=08694a648e355b339d9fd1f1bc38b0747f1f050e;hb=a3ee84371397ba78623f4a04294ef40f7f7f6e7b;hp=55a660784b1670d7591c902b043b26d3479ff47e;hpb=6c3ce7a2b8c0eb86ed493d1a33558e12dacd15e9;p=KiwiIRC.git

diff --git a/README.md b/README.md
index 55a6607..08694a6 100755
--- a/README.md
+++ b/README.md
@@ -1,33 +1,53 @@
-# Installation
+### Kiwi IRC - A hand-crafted IRC client
+Kiwi IRC is a fully featured IRC client that can be extended to suit almost any needs.
+Using the web application is extremly simple even without any IRC knowledge as all the common needs are built directly into the UI.
 
-* Install the dependencies
+For more information see https://kiwiirc.com or live instance of the application can be found at https://kiwiirc.com/client/.
+Our development IRC channel is on the Freenode network, irc.freenode.net #kiwiirc.
 
-    $npm install jade
+**Developing? Please use the development branch - not the master branch!**
 
-    $npm install node-static
+[![Visit our IRC channel](https://kiwiirc.com/buttons/irc.freenode.net/kiwiirc.png)](https://kiwiirc.com/client/irc.freenode.net/#kiwiirc)
 
-    $npm install uglify-js
 
-    $npm install socket.io
+### Installation
 
-    $npm install socket.io-client
-    
-* If you're using SSL, create your certificate and key, place it in the node foder.
+*Note: This requires Node.js to run. Make sure you have installed Node.js first! http://nodejs.org/download/*
 
-* Edit the configuration file
+1. Download the Kiwi source or clone the git repository:
 
-    $nano server/config.json
-    
-# Running 
-    $node server/kiwi.js
+    `$ git clone https://github.com/prawnsalad/KiwiIRC.git && cd KiwiIRC`
 
-# Bugs
-Report bugs using the issue tracker on github: https://github.com/prawnsalad/KiwiIRC/issues
+2. Install the dependencies:
+
+    `$ npm install`
+
+3. Copy and edit the configuration file as needed:
+
+    `$ cp config.example.js config.js`
+
+    `$ nano config.js`
+
+4.  Make sure the client code is built:
+
+    `$ ./kiwi build`
 
-# Licence
 
-To be decided
+### Running
+From the source folder: `$ ./kiwi start`
+
+You can also run kiwi in the foreground to see any output by using the `-f` flag. Eg: `$ ./kiwi -f`
+
+Open your new Kiwi instance in your browser. By default: http://localhost:7778/
+
+
+### Bugs
+Report bugs using the issue tracker on github: https://github.com/prawnsalad/KiwiIRC/issues
+
+### Licence
+GNU Affero
+http://www.gnu.org/licenses/agpl.html
 
 
-# Thanks to
+### Thanks to
 The KiwiIRC logo credited to Michael Drahony (www.drahony.com)