Included the NPM package.json file

[KiwiIRC.git] / README.md

# Installation\r
\r
* Download the Kiwi source or clone the git repository:\r
    $ git clone git@github.com:prawnsalad/KiwiIRC.git\r
\r
* Install the dependancies:\r
    $ npm install\r
    \r
* If you're using SSL, create your certificate and key, place it in the server folder.\r
\r
* Edit the configuration file as needed\r
\r
    $ nano server/config.json\r
    \r
# Running \r
From the source folder:\r
    $ node server/kiwi.js\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
The KiwiIRC logo credited to Michael Drahony (www.drahony.com)\r