encoding-down - npm Package Compare versions

Comparing version 5.0.3 to 5.0.4

CHANGELOG.md

@@ -5,197 +5,247 @@ # Changelog
 
+## [5.0.4] - 2018-06-22
+
+### Added
+
+-   Add `LICENSE.md` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+-   Add `CONTRIBUTORS.md` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+-   Add `remark` tooling ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
 ## [5.0.3] - 2018-05-30
 
 ### Changed
-* Replace `util.inherits` with `inherits` module (@ralphtheninja)
 
+-   Replace `util.inherits` with `inherits` module ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
 ## [5.0.2] - 2018-05-23
 
 ### Added
-* Add `UPGRADING.md` (@vweevers)
 
+-   Add `UPGRADING.md` ([**@vweevers**](https://github.com/vweevers))
+
 ### Changed
-* Upgrade `abstract-leveldown` to `5.0.0` (@ralphtheninja)
-* Upgrade `memdown` to `3.0.0` (@vweevers)
 
+-   Upgrade `abstract-leveldown` to `5.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+-   Upgrade `memdown` to `3.0.0` ([**@vweevers**](https://github.com/vweevers))
+
 ## [5.0.1] - 2018-05-19
 
 ### Changed
-* Override `_setupIteratorOptions` to not clobber ranges (@ralphtheninja, @dominictarr)
 
+-   Override `_setupIteratorOptions` to not clobber ranges ([**@ralphtheninja**](https://github.com/ralphtheninja), [**@dominictarr**](https://github.com/dominictarr))
+
 ## [4.0.1] - 2018-05-19
 
 ### Changed
-* Override `_setupIteratorOptions` to not clobber ranges (@ralphtheninja, @dominictarr)
 
+-   Override `_setupIteratorOptions` to not clobber ranges ([**@ralphtheninja**](https://github.com/ralphtheninja), [**@dominictarr**](https://github.com/dominictarr))
+
 ## [5.0.0] - 2018-05-13
 
 ### Added
-* Add 10 to Travis (@ralphtheninja)
 
+-   Add 10 to Travis ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
 ### Changed
-* Update `level-errors` to `2.0.0` (@ralphtheninja)
-* Update `level-codec` to `9.0.0` (@ralphtheninja)
 
+-   Update `level-errors` to `2.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+-   Update `level-codec` to `9.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
 ### Removed
-* Remove 4 from Travis (@ralphtheninja)
 
+-   Remove 4 from Travis ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
 ## [4.0.0] - 2018-02-12
 
 ### Added
-* Add 9 to Travis (@ralphtheninja)
 
+-   Add 9 to Travis ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
 ### Changed
-* Update `abstract-leveldown` to `4.0.0` (@ralphtheninja)
-* Update `memdown` to `2.0.0` (@ralphtheninja)
 
+-   Update `abstract-leveldown` to `4.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+-   Update `memdown` to `2.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
 ### Removed
-* Remove 7 from Travis (@ralphtheninja)
 
+-   Remove 7 from Travis ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
 ## [3.0.1] - 2017-12-18
 
 ### Added
-* Test that default utf8 encoding stringifies numbers (@vweevers)
 
+-   Test that default utf8 encoding stringifies numbers ([**@vweevers**](https://github.com/vweevers))
+
 ### Fixed
-* Skip decoding if `options.keys` or `options.values` is false (@vweevers)
 
+-   Skip decoding if `options.keys` or `options.values` is false ([**@vweevers**](https://github.com/vweevers))
+
 ## [3.0.0] - 2017-11-11
 
 ### Added
-* README: add node badge (>= 4) (@vweevers)
 
+-   README: add node badge (>= 4) ([**@vweevers**](https://github.com/vweevers))
+
 ### Changed
-* Update `abstract-leveldown` to `3.0.0` (@ralphtheninja)
 
+-   Update `abstract-leveldown` to `3.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
 ### Removed
-* Remove 0.12 from Travis (@vweevers)
 
+-   Remove 0.12 from Travis ([**@vweevers**](https://github.com/vweevers))
+
 ## [2.3.4] - 2017-10-24
 
 ### Added
-* README: add example of npm installed encoding (@vweevers)
 
+-   README: add example of npm installed encoding ([**@vweevers**](https://github.com/vweevers))
+
 ## [2.3.3] - 2017-10-22
 
 ### Changed
-* README: fix `level-codec` links (@vweevers)
 
+-   README: fix `level-codec` links ([**@vweevers**](https://github.com/vweevers))
+
 ## [2.3.2] - 2017-10-22
 
 ### Changed
-* README: tweak badges (@ralphtheninja)
-* README: add more code examples (@vweevers)
-* Update `level-codec` to `8.0.0` (@ralphtheninja)
 
+-   README: tweak badges ([**@ralphtheninja**](https://github.com/ralphtheninja))
+-   README: add more code examples ([**@vweevers**](https://github.com/vweevers))
+-   Update `level-codec` to `8.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
 ### Fixed
-* Fix problems related to missing `asBuffer`, `keyAsBuffer` and `valueAsBuffer` (@ralphtheninja)
 
+-   Fix problems related to missing `asBuffer`, `keyAsBuffer` and `valueAsBuffer` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
 ## [2.3.1] - 2017-10-02
 
 ### Changed
-* Refactor typings (@MeirionHughes)
 
+-   Refactor typings ([**@MeirionHughes**](https://github.com/MeirionHughes))
+
 ## [2.3.0] - 2017-09-24
 
 ### Added
-* Add default export (@zixia)
 
+-   Add default export ([**@zixia**](https://github.com/zixia))
+
 ## [2.2.1] - 2017-09-13
 
 ### Fixed
-* Fix typings (@MeirionHughes)
 
+-   Fix typings ([**@MeirionHughes**](https://github.com/MeirionHughes))
+
 ## [2.2.0] - 2017-09-12
 
 ### Added
-* Add Typescript typings (@MeirionHughes)
 
+-   Add Typescript typings ([**@MeirionHughes**](https://github.com/MeirionHughes))
+
 ### Changed
-* README: `AbstractLevelDOWN` -> `abstract-leveldown` (@ralphtheninja)
-* Update `abstract-leveldown` (@ralphtheninja)
 
+-   README: `AbstractLevelDOWN` -> `abstract-leveldown` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+-   Update `abstract-leveldown` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
 ## [2.1.5] - 2017-08-18
 
 ### Added
-* README: add api docs (@ralphtheninja)
-* Add basic tests (@ralphtheninja)
 
+-   README: add api docs ([**@ralphtheninja**](https://github.com/ralphtheninja))
+-   Add basic tests ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
 ### Changed
-* Enable Travis for ci (@ralphtheninja)
-* Update dependencies (@ralphtheninja)
-* Use `safe-buffer` (@ralphtheninja)
 
+-   Enable Travis for ci ([**@ralphtheninja**](https://github.com/ralphtheninja))
+-   Update dependencies ([**@ralphtheninja**](https://github.com/ralphtheninja))
+-   Use `safe-buffer` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
 ## [2.1.4] - 2017-01-26
 
 ### Fixed
-* Rename methods to `_serializeKey()` and `_serializeValue()` (@juliangruber)
 
+-   Rename methods to `_serializeKey()` and `_serializeValue()` ([**@juliangruber**](https://github.com/juliangruber))
+
 ## [2.1.3] - 2017-01-26
 
 ### Added
-* Add `_encodeKey()` and `_encodeValue()` id functions (@juliangruber)
 
+-   Add `_encodeKey()` and `_encodeValue()` id functions ([**@juliangruber**](https://github.com/juliangruber))
+
 ## [2.1.2] - 2017-01-26
 
 ### Fixed
-* Emit encoding errors in streams too (@juliangruber)
 
+-   Emit encoding errors in streams too ([**@juliangruber**](https://github.com/juliangruber))
+
 ## [2.1.1] - 2017-01-26
 
 ### Fixed
-* Return encoding errors on get (@juliangruber)
 
+-   Return encoding errors on get ([**@juliangruber**](https://github.com/juliangruber))
+
 ## [2.1.0] - 2017-01-26
 
 ### Added
-* Add support for `approximateSize()` (@juliangruber)
 
+-   Add support for `approximateSize()` ([**@juliangruber**](https://github.com/juliangruber))
+
 ## [2.0.8] - 2017-01-26
 
 ### Removed
-* Remove `Iterator.prototype.seek` (@juliangruber)
 
+-   Remove `Iterator.prototype.seek` ([**@juliangruber**](https://github.com/juliangruber))
+
 ### Fixed
-* Fix encoding lt/get range options (@juliangruber)
 
+-   Fix encoding lt/get range options ([**@juliangruber**](https://github.com/juliangruber))
+
 ## [2.0.7] - 2017-01-26
 
 ### Added
-* Add `'utf8'` as default encoding (@juliangruber)
 
+-   Add `'utf8'` as default encoding ([**@juliangruber**](https://github.com/juliangruber))
+
 ## [2.0.6] - 2017-01-26
 
 ### Fixed
-* Fix `typof` -> `typeof` bug (@juliangruber)
 
+-   Fix `typof` -> `typeof` bug ([**@juliangruber**](https://github.com/juliangruber))
+
 ## [2.0.5] - 2017-01-26
 
 ### Fixed
-* Fix bug in `iterator._next()` with undefined key or value (@juliangruber)
 
+-   Fix bug in `iterator._next()` with undefined key or value ([**@juliangruber**](https://github.com/juliangruber))
+
 ## [2.0.4] - 2017-01-26
 
 ### Changed
-* Update `level-codec` for utf8 fixes (@juliangruber)
 
+-   Update `level-codec` for utf8 fixes ([**@juliangruber**](https://github.com/juliangruber))
+
 ## [2.0.3] - 2017-01-26
 
 ### Fixed
-* Fix bug with incorrect db (@juliangruber)
 
+-   Fix bug with incorrect db ([**@juliangruber**](https://github.com/juliangruber))
+
 ## [2.0.2] - 2017-01-26
 
 ### Fixed
-* Fix bug with incorrect db and missing new operator (@juliangruber)
 
+-   Fix bug with incorrect db and missing new operator ([**@juliangruber**](https://github.com/juliangruber))
+
 ## [2.0.1] - 2017-01-26
 
 ### Fixed
-* Fix bug with `AbstractChainedBatch` inheritance (@juliangruber)
 
+-   Fix bug with `AbstractChainedBatch` inheritance ([**@juliangruber**](https://github.com/juliangruber))
+
 ## [2.0.0] - 2017-01-26
 
 ### Changed
-* Version bump (@juliangruber)
 
+-   Version bump ([**@juliangruber**](https://github.com/juliangruber))
+
 ## 1.0.0 - 2017-01-26
@@ -205,32 +255,64 @@
 
-[Unreleased]: https://github.com/level/encoding-down/compare/v5.0.3...HEAD
+[unreleased]: https://github.com/level/encoding-down/compare/v5.0.4...HEAD
+
+[5.0.4]: https://github.com/level/encoding-down/compare/v5.0.3...v5.0.4
+
 [5.0.3]: https://github.com/level/encoding-down/compare/v5.0.2...v5.0.3
+
 [5.0.2]: https://github.com/level/encoding-down/compare/v5.0.1...v5.0.2
+
 [5.0.1]: https://github.com/level/encoding-down/compare/v5.0.0...v5.0.1
+
 [5.0.0]: https://github.com/level/encoding-down/compare/v4.0.0...v5.0.0
+
 [4.0.1]: https://github.com/level/encoding-down/compare/v4.0.0...v4.0.1
+
 [4.0.0]: https://github.com/level/encoding-down/compare/v3.0.1...v4.0.0
+
 [3.0.1]: https://github.com/level/encoding-down/compare/v3.0.0...v3.0.1
+
 [3.0.0]: https://github.com/level/encoding-down/compare/v2.3.4...v3.0.0
+
 [2.3.4]: https://github.com/level/encoding-down/compare/v2.3.3...v2.3.4
+
 [2.3.3]: https://github.com/level/encoding-down/compare/v2.3.2...v2.3.3
+
 [2.3.2]: https://github.com/level/encoding-down/compare/v2.3.1...v2.3.2
+
 [2.3.1]: https://github.com/level/encoding-down/compare/v2.3.0...v2.3.1
+
 [2.3.0]: https://github.com/level/encoding-down/compare/v2.2.1...v2.3.0
+
 [2.2.1]: https://github.com/level/encoding-down/compare/v2.2.0...v2.2.1
+
 [2.2.0]: https://github.com/level/encoding-down/compare/v2.1.5...v2.2.0
+
 [2.1.5]: https://github.com/level/encoding-down/compare/v2.1.4...v2.1.5
+
 [2.1.4]: https://github.com/level/encoding-down/compare/v2.1.3...v2.1.4
+
 [2.1.3]: https://github.com/level/encoding-down/compare/v2.1.2...v2.1.3
+
 [2.1.2]: https://github.com/level/encoding-down/compare/v2.1.1...v2.1.2
+
 [2.1.1]: https://github.com/level/encoding-down/compare/v2.1.0...v2.1.1
+
 [2.1.0]: https://github.com/level/encoding-down/compare/v2.0.8...v2.1.0
+
 [2.0.8]: https://github.com/level/encoding-down/compare/v2.0.7...v2.0.8
+
 [2.0.7]: https://github.com/level/encoding-down/compare/v2.0.6...v2.0.7
+
 [2.0.6]: https://github.com/level/encoding-down/compare/v2.0.5...v2.0.6
+
 [2.0.5]: https://github.com/level/encoding-down/compare/v2.0.4...v2.0.5
+
 [2.0.4]: https://github.com/level/encoding-down/compare/v2.0.3...v2.0.4
+
 [2.0.3]: https://github.com/level/encoding-down/compare/v2.0.2...v2.0.3
+
 [2.0.2]: https://github.com/level/encoding-down/compare/v2.0.1...v2.0.2
+
 [2.0.1]: https://github.com/level/encoding-down/compare/v2.0.0...v2.0.1
+
 [2.0.0]: https://github.com/level/encoding-down/compare/v1.0.0...v2.0.0

package.json

 {
   "name": "encoding-down",
-  "version": "5.0.3",
+  "version": "5.0.4",
   "license": "MIT",
@@ -9,6 +9,11 @@ "repository": "level/encoding-down",
   "scripts": {
-    "test": "standard && node test"
+    "test": "standard && node test",
+    "remark": "remark README.md CONTRIBUTORS.md CHANGELOG.md UPGRADING.md -o"
   },
   "devDependencies": {
+    "level-community": "^3.0.0",
     "memdown": "^3.0.0",
+    "remark-cli": "^5.0.0",
+    "remark-git-contributors": "^0.2.1",
+    "remark-github": "^7.0.3",
     "safe-buffer": "^5.1.1",
@@ -25,2 +30,13 @@ "standard": "^11.0.0",
   },
+  "remarkConfig": {
+    "plugins": [
+      [
+        "remark-git-contributors",
+        "level-community"
+      ],
+      [
+        "remark-github"
+      ]
+    ]
+  },
   "engines": {
@@ -27,0 +43,0 @@ "node": ">=6"

README.md

@@ -15,3 +15,3 @@ # encoding-down
 
-Stores like [`leveldown`] can only store strings and Buffers. For a richer set of data types you can wrap such a store with `encoding-down`. It allows you to specify an *encoding* to use for keys and values independently. This not only widens the range of input types, but also limits the range of output types. The encoding is applied to all read and write operations: it encodes writes and decodes reads.
+Stores like [`leveldown`] can only store strings and Buffers. For a richer set of data types you can wrap such a store with `encoding-down`. It allows you to specify an _encoding_ to use for keys and values independently. This not only widens the range of input types, but also limits the range of output types. The encoding is applied to all read and write operations: it encodes writes and decodes reads.
 
@@ -122,6 +122,6 @@ [Many encodings are builtin][builtin-encodings] courtesy of [`level-codec`]. The default encoding is `utf8` which ensures you'll always get back a string. You can also provide a custom encoding like `bytewise` - [or your own](#custom-encodings)!
 
-* `db` must be an [`abstract-leveldown`] compliant store
-* `options` are passed to [`level-codec`]:
-  - `keyEncoding`: encoding to use for keys
-  - `valueEncoding`: encoding to use for values
+-   `db` must be an [`abstract-leveldown`] compliant store
+-   `options` are passed to [`level-codec`]:
+    -   `keyEncoding`: encoding to use for keys
+    -   `valueEncoding`: encoding to use for values
 
@@ -171,10 +171,16 @@ Both encodings default to `'utf8'`. They can be a string (builtin `level-codec` encoding) or an object (custom encoding).
 
-MIT
+[MIT](./LICENSE.md) © 2017-present `encoding-down` [Contributors](./CONTRIBUTORS.md).
 
 [level-badge]: http://leveldb.org/img/badge.svg
+
 [`abstract-leveldown`]: https://github.com/level/abstract-leveldown
+
 [`leveldown`]: https://github.com/level/leveldown
+
 [`level`]: https://github.com/level/level
+
 [`level-codec`]: https://github.com/level/codec
+
 [builtin-encodings]: https://github.com/level/codec#builtin-encodings
+
 [encoding-format]: https://github.com/level/codec#encoding-format

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

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

29815

increased by21.26%

Number of package files

9

increased by28.57%

Number of lines in readme file

184

increased by3.37%

Worsened metrics

Dev dependency count

8

increased by100%

No dependency changes