hypercore-promisifier - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "hypercore-promisifier",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A Hypercore wrapper that lets you switch between callback and Promise APIs",
@@ -31,4 +31,5 @@ "main": "index.js",
   "dependencies": {
+    "call-me-maybe": "^1.0.1",
     "inspect-custom-symbol": "^1.1.1"
   }
 }

README.md

 # hypercore-promisifier
+![Test on Node.js](https://github.com/andrewosh/hypercore-promisifier/workflows/Test%20on%20Node.js/badge.svg)
+
+A wrapper that provides conversion to/from callback/promise interfaces in Hypercore and RemoteHypercore.
+
+## Installation
+```
+npm i hypercore-promisifier
+```
+
+## Usage
+```js
+const hypercore = require('hypercore')
+const ram = require('random-access-memory')
+const { toPromises } = require('hypercore-promisifier')
+
+const core = hypercore(ram)
+
+// A promisified Hypercore interface
+const wrapper = toPromises(core)
+```
+
+## API
+The API supports two methods, each one returning a compatibilty wrapper around Hypercore.
+
+#### `const { toCallbacks, toPromises } = require('hypercore-promisifier')`
+
+`toCallbacks(core)` takes a Hypercore-like object with a Promises API, and returns a wrapper with a
+callbacks interfaced.
+
+`toPromises(core)` takes a Hypercore-like object with a callbacks API, and returns a wrapper with a
+Promises interface.
+
+## License
+MIT
+

No alert changes

Improved metrics

Total package byte prevSize

10766

increased by31.55%

Number of package files

6

increased by50%

Number of lines in readme file

37

increased by1750%

Worsened metrics

Dependency count

2

increased by100%

Dependency changes

• + Addedcall-me-maybe@^1.0.1

• + Addedcall-me-maybe@1.0.2(transitive)