Skip to content

Commit

Permalink
Prepare 2.0.1 (#31)
Browse files Browse the repository at this point in the history
* Add UPGRADING.md

* Update changelog for 2.0.1

* Mention why encodings were removed
  • Loading branch information
ralphtheninja authored Jun 10, 2018
1 parent 87607ae commit 67ccea7
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down
14 changes: 14 additions & 0 deletions UPGRADING.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 67ccea7

Please sign in to comment.