From 01d4f129198b1906e45cc4fe424e3f1f3cf521ec Mon Sep 17 00:00:00 2001 From: Christian Smith Date: Thu, 4 Aug 2011 19:51:05 -0700 Subject: [PATCH] package.json and README edits --- README.md | 11 ++++++++--- package.json | 13 +++++++++++-- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a5ee41f..bda0498 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,12 @@ A loosely-ordered random-access queue for JSON documents implemented with Node a ## Installation +Install globally to use the norq executable: + + $ npm install -g norq + +Install locally to use norq as a dependency: + $ npm install norq ## Configuration @@ -159,16 +165,15 @@ HTTP API ## Running the Tests - Get the source from GitHub, then in the root directory: + Get the source from GitHub, install nodeunit and expresso globally, then in the root directory: $ nodeunit test/test-norq.js test/test-logger.js test/test-config.js $ expresso test/test-http.js ## Acknowledgements - Thanks to my friends and family for all your support and encouragement. - Thanks to the open source software community for sharing your work. Norq is built with: + * Node.js and Redis (of course) * node_redis * node-uuid diff --git a/package.json b/package.json index 713be4e..fe83312 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,10 @@ { "name": "norq", - "description": "Queue implementation for Node backed by Redis", + "description": "A loosely-ordered random-access queue for JSON documents implemented with Node.js and Redis.", "keywords": ["json", "queue", "redis", "json-schema", "rest"], "version": "0.0.0", "repository": { - "url": "" + "url": "git://github.com/christiansmith/norq.git" }, "author": "Christian Smith (http://anvil.io)", "main": "index", @@ -12,6 +12,15 @@ "directories": { "lib": "." }, + "dependencies": { + "express": "2.4.3", + "winston": "0.3.3", + "redis": "0.6.7", + "node-uuid": "1.2.0" + }, + "devDependencies": { + "nodeunit": "0.5.3" + }, "engines": { "node": "*" }