encoding-down - npm Package Compare versions

Comparing version 2.1.4 to 2.1.5

package.json

 {
   "name": "encoding-down",
-  "version": "2.1.4",
+  "version": "2.1.5",
   "license": "MIT",
@@ -8,7 +8,9 @@ "repository": "level/encoding-down",
   "scripts": {
-    "test": "standard"
+    "test": "standard && node test"
   },
   "devDependencies": {
-    "standard": "^8.6.0",
-    "tape": "^4.6.3"
+    "memdown": "^1.2.4",
+    "safe-buffer": "^5.1.1",
+    "standard": "^10.0.3",
+    "tape": "^4.8.0"
   },
@@ -15,0 +17,0 @@ "dependencies": {

README.md

@@ -1,12 +0,35 @@
-
 # encoding-down
 
-WIP LevelDOWN wrapper supporting levelup@1 encodings. For motivation, see [this issue](https://github.com/Level/levelup/pull/367).
+<img alt="LevelDB Logo" height="100" src="http://leveldb.org/img/logo.svg">
 
+[`AbstractLevelDOWN`](https://github.com/level/abstract-leveldown) wrapper supporting levelup@1 encodings. For motivation, see [this issue](https://github.com/Level/levelup/pull/367).
+
+[![Build Status](https://travis-ci.org/Level/encoding-down.svg?branch=master)](https://travis-ci.org/Level/encoding-down) [![Greenkeeper badge](https://badges.greenkeeper.io/Level/encoding-down.svg)](https://greenkeeper.io/)
+
+## Usage
+
+```js
+const levelup = require('levelup')
+const leveldown = require('leveldown')
+const enc = require('encoding-down')
+const db = levelup(enc(leveldown('./db')))
+db.put('name', 'encoding-down', function (err) {
+  db.get('name', function (err, value) {
+    if (!err) console.log('name=', value)
+  })
+})
+```
+
 ## API
 
-__TODO__
+### `var db = require('encoding-down')(db[, options])`
 
+* `db` `AbstractLevelDOWN` compatible db such as `leveldown`, `memdown` etc
+* `options.keyEncoding` (string) defaults to `'utf8'`
+* `options.valueEncoding` (string) defaults to `'utf8'`
+
+`options` are passed to [`level-codec`](https://github.com/level/codec), see [supported encodings](https://github.com/Level/codec#encodings) for more information.
+
 ## 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

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

Improved metrics

Total package byte prevSize

8042

increased by105.78%

Number of package files

6

increased by50%

Lines of code

215

increased by93.69%

Number of lines in readme file

36

increased by176.92%

Worsened metrics

Dev dependency count

4

increased by100%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes