From ed515498b06ad5ba2a86c159052100b504a8d5ba Mon Sep 17 00:00:00 2001 From: Jack Allnutt Date: Sat, 21 Jan 2012 17:22:42 +0000 Subject: [PATCH] Added package.json so NPM can install dependencies. Modified README.md to reflect this change. --- README.md | 22 ++++++++++------------ package.json | 20 ++++++++++++++++++++ 2 files changed, 30 insertions(+), 12 deletions(-) create mode 100644 package.json diff --git a/README.md b/README.md index ec69ca0..9026079 100755 --- a/README.md +++ b/README.md @@ -1,24 +1,22 @@ # Installation +* Get the Kiwi source and dependencies -* Install the dependencies - - $npm install jade - - $npm install node-static - - $npm install uglify-js - - $npm install socket.io - - $npm install socket.io-client + $git clone https://github.com/prawnsalad/KiwiIRC.git + $npm install -* If you're using SSL, create your certificate and key, place it in the server folder. +* Create your SSL certificate and key, place it in the server folder. * Edit the configuration file $nano server/config.json # Running +Either use npm + + $npm start + +or run node directly + $node server/kiwi.js # Bugs diff --git a/package.json b/package.json new file mode 100644 index 0000000..2ee89f2 --- /dev/null +++ b/package.json @@ -0,0 +1,20 @@ +{ + "scripts": { + "start": "node server/kiwi.js" + }, + "name": "KiwiIRC", + "version": "0.1.0-dev", + "homepage": "http://kiwiirc.com", + "repository" : { + "type" : "git", + "url" : "https://github.com/prawnsalad/KiwiIRC.git" + }, + "dependencies": { + "jade": ">=0.16.2", + "node-static": ">=0.5.9", + "uglify-js": ">=1.1.1", + "socket.io": ">=0.8.5", + "socket.io-client": ">=0.8.5" + }, + "private": true +} -- 2.25.1