ABAValidator - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

HISTORY.md

@@ -0,3 +1,8 @@
+## 2012-08-07 ##
+- Added client-install npm script to begin streamlining client-side install
+- Added install and update npm scripts to provide a notification on how to install ABAValidator for client-side use.
+- package version -> 1.0.4
+
 ## 2012-07-02 ##
 - Updated package to use `keywords` instead of `tags`
 - package version -> 1.0.3

package.json

 {
-  "name": "ABAValidator",
-  "version": "1.0.3",
-  "author": "James Eggers <[e-mail]> (http://www.jamesreggers.com/)",
-  "description": "A validation module for browsers and Node.js to validate an American Bankers Association Routing Number used in ACH payments.",
-  "homepage": "https://github.com/JamesEggers1/node-ABAValidator",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/JamesEggers1/node-ABAValidator.git"
-  },
-  "main": "./src/aba-validation",
-  "engines": {
-    "node": "*"
-  },
-  "scripts": {
-	"test": "mocha tests/aba-validation-tests.js -R spec"
-  },
-  "keywords": [ "ach", "validation", "browser"],
-  "bugs": {
-    "url": "https://github.com/JamesEggers1/node-ABAValidator/issues"
-  },
-  "devDependencies": {
-	"should" : "0.6.3",
-	"mocha":"1.2.1"
+  "name": "ABAValidator"
+  , "version": "1.0.4"
+  , "author": "James Eggers <[e-mail]> (http://www.jamesreggers.com/)"
+  , "description": "A validation module for browsers and Node.js to validate an American Bankers Association Routing Number used in ACH payments."
+  , "homepage": "https://github.com/JamesEggers1/node-ABAValidator"
+  , "repository": {
+    	"type": "git"
+    	, "url": "git://github.com/JamesEggers1/node-ABAValidator.git"
   }
+  , "main": "./src/aba-validation"
+  , "engines": {
+    	"node": "*"
+  }
+  , "scripts": {
+		"test": "mocha tests/aba-validation-tests.js -R spec"
+		, "client-install": "node bin/client-install.js"
+		, "install": "node bin/client-install-directions.js"
+		, "update": "node bin/client-install-directions.js"
+  }
+  , "keywords": [ "ach", "validation", "browser"]
+  , "bugs": {
+    	"url": "https://github.com/JamesEggers1/node-ABAValidator/issues"
+  }
+  , "devDependencies": {
+		"should" : "0.6.3"
+		, "mocha":"1.2.1"
+  }
 }

README.md

@@ -27,4 +27,12 @@ ABAValidator  [![Build Status](https://secure.travis-ci.org/JamesEggers1/node-ABAValidator.png)](http://travis-ci.org/JamesEggers1/node-ABAValidator)
 
-In addition to being usable as a Node.js module, the validator can also be used client-side in the user's web browser.
+## Using ABAValidator Client-Side ##
+In addition to being usable as a Node.js module, the validator can also be used client-side in the user's web browser.  When you install `ABAValidator` using `npm`, instructions will appear how to install it for client-side JavaScript consumption.
 
+While you can copy the `aba-validation.js` file from the module's installation directory under `node_modles`, an automated script has been provided to assist you in this copy process and to make it more streamlined.  To do a client-side install, simply type the following `npm` command:
+
+    npm run-script ABAValidator client-install
+
+Once you run that command, you'll be prompted to provide the path to which to install `aba-validation.js` for use by your client-side JavaScript.  At that point, you can reference the file in your html and JavaScript code as shown below.
+
+
 #### Html ####
@@ -45,3 +53,3 @@
 
-## License ##
+## License (MIT) ##
 
@@ -48,0 +56,0 @@ Copyright (c) 2012 James Eggers

New alerts

Install scripts

Supply chain risk

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Found 1 instance in 1 package

Non-existent author

Supply chain risk

The package was published by an npm account that no longer exists.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10666

increased by63.97%

Number of package files

9

increased by28.57%

Lines of code

151

increased by169.64%

Number of lines in readme file

60

increased by15.38%

Worsened metrics

Number of high supply chain risk alerts

2

increased byInfinity%

Number of low supply chain risk alerts

1

increased byInfinity%

No dependency changes