bs58 - npm Package Compare versions

Comparing version 2.0.1 to 3.0.0

CHANGELOG.md

@@ -0,1 +1,5 @@
+3.0.0 / 2015-08-18
+------------------
+- refactored module into generic [`base-x`](https://github.com/cryptocoinjs/base-x).
+
 2.0.1 / 2014-12-23
@@ -2,0 +6,0 @@ ------------------

package.json

 {
   "name": "bs58",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "Base 58 encoding / decoding",
@@ -16,9 +16,7 @@ "keywords": [
   ],
+  "license": "MIT",
   "devDependencies": {
-    "coveralls": "^2.11.2",
-    "istanbul": "^0.2.10",
-    "jshint": "2.5.1",
-    "mocha": "^1.21.4",
-    "mocha-lcov-reporter": "0.0.1",
-    "mochify": "^2.1.0"
+    "mocha": "^2.0.0",
+    "mochify": "^2.1.0",
+    "standard": "^5.1.0"
   },
@@ -29,11 +27,12 @@ "repository": {
   },
-  "main": "./lib/bs58.js",
+  "main": "index.js",
   "scripts": {
-    "browser-test": "./node_modules/.bin/mochify --wd -R spec",
-    "coverage": "./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha -- --reporter list test/*.js",
-    "coveralls": "npm run-script coverage && node ./node_modules/.bin/coveralls < coverage/lcov.info",
-    "jshint": "./node_modules/.bin/jshint --config jshint.json lib/*.js ; true",
-    "test": "npm run-script unit",
-    "unit": "./node_modules/.bin/mocha"
+    "browser-test": "mochify --wd -R spec",
+    "standard": "standard",
+    "test": "npm run standard && npm run unit",
+    "unit": "mocha"
+  },
+  "dependencies": {
+    "base-x": "^1.0.1"
   }
 }

README.md

@@ -0,15 +1,60 @@
+bs58
+====
 
 [![build status](https://secure.travis-ci.org/cryptocoinjs/bs58.png)](http://travis-ci.org/cryptocoinjs/bs58)
-[![Coverage Status](https://img.shields.io/coveralls/cryptocoinjs/bs58.svg)](https://coveralls.io/r/cryptocoinjs/bs58)
 
-bs58
-====
-
 JavaScript component to compute base 58 encoding. This encoding is typically used for crypto currencies such as Bitcoin.
 
-### Documentation
 
-http://cryptocoinjs.com/modules/misc/bs58/
+Install
+-------
 
+    npm i --save bs58
 
+
+API
+---
+
+### encode(input)
+
+`input` must be a [Buffer](http://nodejs.org/api/buffer.html) or an `Array`. It returns a `string`.
+
+**example**:
+
+```js
+var bs58 = require('bs58')
+
+var unencodedData = "003c176e659bea0f29a3e9bf7880c112b1b31b4dc826268187"
+var out = bs58.encode(new Buffer(unencodedData, 'hex'))
+console.log(out) // => 16UjcYNBG9GTK4uq2f7yYEbuifqCzoLMGS
+```
+
+
+### decode(input)
+
+`input` must be a base 58 encoded string. Returns an `Array`.
+
+**example**:
+
+```js
+var bs58 = require('bs58')
+
+var address = "16UjcYNBG9GTK4uq2f7yYEbuifqCzoLMGS"
+var out = bs58.decode(address)
+console.log(out.toString())
+// => 0,60,23,110,101,155,234,15,41,163,233,191,120,128,193,18,177,179,27,77,200,38,38,129,135
+
+// if using Node.js or browserify
+console.log(new Buffer(out).toString('hex'))
+// => 003c176e659bea0f29a3e9bf7880c112b1b31b4dc826268187
+```
+
+Hack / Test
+-----------
+
+Uses JavaScript standard style. Read more:
+
+[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
+
+
 Credits
@@ -22,1 +67,7 @@ -------
 - [Jared Deckard](https://github.com/deckar01) for killing `bigi` as a dependency
+
+
+License
+-------
+
+MIT

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

3

decreased by-50%

Number of low license alerts

0

decreased by-100%

Number of lines in readme file

73

increased by231.82%

Worsened metrics

Total package byte prevSize

4487

decreased by-18.28%

Dependency count

1

increased byInfinity%

Lines of code

7

decreased by-89.23%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addedbase-x@^1.0.1

• + Addedbase-x@1.1.0(transitive)