X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=README.md;h=7868c356695a02ba7d0c3c1a58c1861e0009cc47;hb=d0469a6fb843c79fca0b10d3fc0e27f3b3ccaca8;hp=6be5b32ee21a1c7b8e936dbee799fc58edbf40eb;hpb=f1f11e8688e5cf2b91805d0240c67f68f89efc11;p=KiwiIRC.git

diff --git a/README.md b/README.md
index 6be5b32..7868c35 100755
--- a/README.md
+++ b/README.md
@@ -1,29 +1,49 @@
-# 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 an example 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
 
-    $npm install node-static
+### Installation
 
-    $npm install uglify-js
+*Note: This requires Node.js to run. Make sure you have installed Node.js first! http://nodejs.org/download/*
 
-    $npm install socket.io
+1. Download the Kiwi source or clone the git repository:
 
-    $npm install socket.io-client
-    
-* Edit the configuration file
+    `$ git clone git@github.com:prawnsalad/KiwiIRC.git && cd KiwiIRC`
 
-    $nano node/config.json
-    
-* If you're using SSL, create your certificate and key, place it in the node foder.
+2. Install the dependencies:
 
-# Running 
-    $node node/kiwi.js
+    `$ npm install`
 
-# Bugs
+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`
+
+
+### 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
+### Licence
+GNU Affero
+http://www.gnu.org/licenses/agpl.html
+
 
-To be decided
\ No newline at end of file
+### Thanks to
+The KiwiIRC logo credited to Michael Drahony (www.drahony.com)