Removing junk from .po files
[KiwiIRC.git] / README.md
index 4adeb37dbe7b0a66792dc9929e5e55ab8781df08..c780c2ab940aedc2bef6c643070ad427bf4be4f1 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -2,31 +2,42 @@
 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 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
+[![Visit our IRC channel](https://kiwiirc.com/buttons/irc.freenode.net/kiwiirc.png)](https://kiwiirc.com/client/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`\r
+    `$ git clone https://github.com/prawnsalad/KiwiIRC.git && cd KiwiIRC`\r
+\r
+2. Install the dependencies:\r
 \r
-2. Install the dependancies and make sure the client code is built:\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
 \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