From c5396b547ac10b2354dddc94c849658a05b2ca36 Mon Sep 17 00:00:00 2001 From: James Eggers Date: Tue, 29 May 2012 13:51:10 -0500 Subject: [PATCH] Updated the readme and package.json files in preperation of publishing. --- README.md | 12 +++++++++--- package.json | 13 ++++++++----- 2 files changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f2fb58d..931a67b 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,23 @@ -ABA-Validator +ABAValidator ============= The American Bankers Association validation module provides a way of validating US-based Routing Number both on the client side in the user's browser as well as server side with Node.js. ## Installation ## -TBD + npm install ABAValidator ## Testing ## +The ABAValidator module has unit tests built around it than can be used to verify the package before usage. The tests are written with the Mocha and Should modules and running the below command will import such. + + npm test ABAValidator + +## Node.js Usage ## + TBD -## Usage ## +## Web Browser Usage ## TBD diff --git a/package.json b/package.json index 04b6f22..84cb435 100644 --- a/package.json +++ b/package.json @@ -1,18 +1,21 @@ { - "name": "aba-validation", + "name": "ABAValidator", "version": "0.0.1", "author": "James Eggers (http://www.jamesreggers.com/)", - "description": "A client and server side validation module for validating US-based Routing Numbers.", + "description": "A validation module for browsers and Node.js to validate an American Bankers Association Routing Number used in ACH payments.", "repository": { "type": "git", - "url": "git://github.com/JamesEggers1/TBD" + "url": "git://github.com/JamesEggers1/node-ABAValidator" }, - "main": "./aba-validation.JS", + "main": "./src/aba-validation", "engines": { "node": "*" }, + "scripts": { + "test": "make test" + }, "tags": [ "ach", "validation"], "bugs": { - "url": "https://github.com/JamesEggers1/TBD/issues" + "url": "https://github.com/JamesEggers1/node-ABAValidator/issues" } } \ No newline at end of file