LibreJS compatibility modifications

[KiwiIRC.git] / README.md

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