From 67ccea71fd02e22609fd37cf95624a87fae3018d Mon Sep 17 00:00:00 2001 From: Lars-Magnus Skog Date: Sun, 10 Jun 2018 18:34:10 +0200 Subject: [PATCH] Prepare 2.0.1 (#31) * Add UPGRADING.md * Update changelog for 2.0.1 * Mention why encodings were removed --- CHANGELOG.md | 6 +++++- README.md | 2 ++ UPGRADING.md | 14 ++++++++++++++ 3 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 UPGRADING.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 7b1dd1d..5f2739e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,12 +2,15 @@ ## [Unreleased] +## [2.0.1] - 2018-06-10 + ### Changed * Upgrade `leveldown` devDependency from `^1.4.1` to `^4.0.0` (@ralphtheninja) * Upgrade `standard` devDependency from `^10.0.3` to `^11.0.0` (@ralphtheninja) ### Added * Add node 9 and 10 to Travis (@ralphtheninja) +* Add `UPGRADING.md` (@ralphtheninja) ### Removed * Remove node 7 from Travis (@ralphtheninja) @@ -70,7 +73,8 @@ :seedling: Initial release. -[Unreleased]: https://github.com/level/iterator-stream/compare/v2.0.0...HEAD +[Unreleased]: https://github.com/level/iterator-stream/compare/v2.0.1...HEAD +[2.0.1]: https://github.com/level/iterator-stream/compare/v2.0.0...v2.0.1 [2.0.0]: https://github.com/level/iterator-stream/compare/v1.3.1...v2.0.0 [1.3.1]: https://github.com/level/iterator-stream/compare/v1.3.0...v1.3.1 [1.3.0]: https://github.com/level/iterator-stream/compare/v1.2.0...v1.3.0 diff --git a/README.md b/README.md index 721d0d7..607b7e8 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ ## Usage +**If you are upgrading:** please see [UPGRADING.md](UPGRADING.md). + ```js var iteratorStream = require('level-iterator-stream') var leveldown = require('leveldown') diff --git a/UPGRADING.md b/UPGRADING.md new file mode 100644 index 0000000..d7620b9 --- /dev/null +++ b/UPGRADING.md @@ -0,0 +1,14 @@ +# Upgrade Guide + +This document describes breaking changes and how to upgrade. For a complete list of changes including minor and patch releases, please refer to the [changelog](CHANGELOG.md). + +## v2 + +Encodings were factored out from `levelup` into `encoding-down` and in that process they were removed from this module as well. For more information, please check the corresponding `CHANGELOG.md` for: + +* [`levelup`](https://github.com/Level/levelup/blob/master/CHANGELOG.md) +* [`encoding-down`](https://github.com/Level/encoding-down/blob/master/CHANGELOG.md) + +If your code relies on `options.decoder` for decoding keys and values you need to handle this yourself, e.g. by a transform stream or similar. + +Support for node 0.10, 0.12 and iojs was also dropped.