cyclical-object-hash - npm Package Compare versions

Comparing version 0.0.0 to 0.0.1

package.json

 {
   "name": "cyclical-object-hash",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Deterministically hash a cyclical object with blake2b",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,3 +0,3 @@
-# object-hash [![stability][0]][1]
-[![npm version][2]][3] [![build status][4]][5] [![test coverage][6]][7]
+# cylical-object-hash [![stability][0]][1]
+[![npm version][2]][3] 
 [![downloads][8]][9] [![js-standard-style][10]][11]
@@ -9,3 +9,3 @@
 ```js
-const objectHash = require('object-hash')
+const objectHash = require('cylical-object-hash')
 
@@ -15,25 +15,2 @@ let exampleObject = {
   "@type": "Book",
-  "accessibilityAPI": "ARIA",
-  "accessibilityControl": [
-    "fullKeyboardControl",
-    "fullMouseControl"
-  ],
-  "accessibilityFeature": [
-    "largePrint/CSSEnabled",
-    "highContrast/CSSEnabled",
-    "resizeText/CSSEnabled",
-    "displayTransformability",
-    "longDescription",
-    "alternativeText"
-  ],
-  "accessibilityHazard": [
-    "noFlashingHazard",
-    "noMotionSimulationHazard",
-    "noSoundHazard"
-  ],
-  "aggregateRating": {
-    "@type": "AggregateRating",
-    "reviewCount": "0"
-  },
-  "bookFormat": "EBook/DAISY3",
   "copyrightHolder": {
@@ -59,15 +36,18 @@ "@type": "Organization",
 // '79fc74f0dd70d955a7d61271d09f0806aadff55ea770621cbb9a9194e9b9053cc59c3ca669b273dd0fb1a0efc4617d2c9824a339ad0200fdbd231b549f946027'
+
 objectHash(exampleObject)
 // Uint8Array 
 // Blake2b { digestLength: 64, finalized: false, pointer: 64 }
-
 ```
 
 ## API
-### objectHash
-object
+### objectHash(obj)
+This takes an ordinary object and will deterministically hash it via blake2b. It returns a Uint8Array by default.
 
+### .hex(obj)
+This takes an ordinary object and will deterministically hash it via blake2b. Unlike the function above, it returns it as a hex string.
+
 ## Installation
 ```sh
-$ npm install object-hash
+$ npm install cyclical-object-hash
 ```
@@ -80,11 +60,10 @@
 [1]: https://nodejs.org/api/documentation.html#documentation_stability_index
-[2]: https://img.shields.io/npm/v/object-hash.svg?style=flat-square
-[3]: https://npmjs.org/package/object-hash
-[4]: https://img.shields.io/travis/jdvorak/object-hash/master.svg?style=flat-square
-[5]: https://travis-ci.org/jdvorak/object-hash
+[2]: https://img.shields.io/npm/v/cyclical-object-hash.svg?style=flat-square
+[3]: https://npmjs.org/package/cyclical-object-hash
+[4]: https://img.shields.io/travis/jdvorak/cyclical-object-hash/master.svg?style=flat-square
 [6]: https://img.shields.io/codecov/c/github/jdvorak/object-hash/master.svg?style=flat-square
-[7]: https://codecov.io/github/jdvorak/object-hash
-[8]: http://img.shields.io/npm/dm/object-hash.svg?style=flat-square
-[9]: https://npmjs.org/package/object-hash
+[7]: https://codecov.io/github/jdvorak/cyclical-object-hash
+[8]: http://img.shields.io/npm/dm/cyclical-object-hash.svg?style=flat-square
+[9]: https://npmjs.org/package/cyclical-object-hash
 [10]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
 [11]: https://github.com/feross/standard

No alert changes

Worsened metrics

Total package byte prevSize

6366

decreased by-4.31%

Number of lines in readme file

66

decreased by-24.14%

No dependency changes