Added package.json so NPM can install dependencies. Modified README.md to reflect...
authorJack Allnutt <m2ys4u@Gmail.com>
Sat, 21 Jan 2012 17:22:42 +0000 (17:22 +0000)
committerJack Allnutt <m2ys4u@Gmail.com>
Sat, 21 Jan 2012 17:22:42 +0000 (17:22 +0000)
README.md
package.json [new file with mode: 0644]

index ec69ca0956e5a55fa1c285b6aa7045588ac06b7f..9026079088d89272e4d03c22e3396c2142ade190 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -1,24 +1,22 @@
 # Installation\r
+* Get the Kiwi source and dependencies\r
 \r
-* Install the dependencies\r
-\r
-    $npm install jade\r
-\r
-    $npm install node-static\r
-\r
-    $npm install uglify-js\r
-\r
-    $npm install socket.io\r
-\r
-    $npm install socket.io-client\r
+    $git clone https://github.com/prawnsalad/KiwiIRC.git\r
+    $npm install\r
     \r
-* If you're using SSL, create your certificate and key, place it in the server folder.\r
+* Create your SSL certificate and key, place it in the server folder.\r
 \r
 * Edit the configuration file\r
 \r
     $nano server/config.json\r
     \r
 # Running \r
+Either use npm\r
+\r
+    $npm start\r
+\r
+or run node directly\r
+\r
     $node server/kiwi.js\r
 \r
 # Bugs\r
diff --git a/package.json b/package.json
new file mode 100644 (file)
index 0000000..2ee89f2
--- /dev/null
@@ -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
+}