Permalink
Browse files

package.json and README edits

  • Loading branch information...
christiansmith committed Aug 5, 2011
1 parent 65c6a8c commit 01d4f129198b1906e45cc4fe424e3f1f3cf521ec
Showing with 19 additions and 5 deletions.
  1. +8 −3 README.md
  2. +11 −2 package.json
View
@@ -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
View
@@ -1,17 +1,26 @@
{
"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 <smith@anvil.io> (http://anvil.io)",
"main": "index",
"bin": { "norq": "./bin/norq" },
"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": "*"
}

0 comments on commit 01d4f12

Please sign in to comment.