Client: Added app.panels() to global object

[KiwiIRC.git] / README.md

diff --git a/README.md b/README.md
index ece5a39d08fc812f29b4ccdfadede25bcb57068c..7868c356695a02ba7d0c3c1a58c1861e0009cc47 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -2,25 +2,32 @@
 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
-For more information see http://kiwiirc.com or an example of the application can be found at http://kiwiirc.com/client/\r
+For more information see https://kiwiirc.com or an example 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
 \r
 ### Installation\r
 \r
+*Note: This requires Node.js to run. Make sure you have installed Node.js first! http://nodejs.org/download/*\r
+\r
 1. Download the Kiwi source or clone the git repository:\r
 \r
     `$ git clone git@github.com:prawnsalad/KiwiIRC.git && cd KiwiIRC`\r
 \r
-2. Install the dependancies and make sure the client code is built:\r
-    \r
+2. Install the dependencies:\r
+\r
     `$ npm install`\r
 \r
-    `$ node client/assets/dev/build.js`\r
+3. Copy and edit the configuration file as needed:\r
 \r
-3. Edit the configuration file as needed:\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
 \r
 ### Running\r
 From the source folder: `$ ./kiwi start`\r