diff --git a/CHANGELOG.md b/CHANGELOG.md index 2010f11..2f6c002 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,22 @@ # Changelog +## [4.0.0] - 2022-07-01 + +_If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md)._ + +### Changed + +- **Breaking:** bump [`readable-stream`](https://github.com/nodejs/readable-stream) from 3 to 4 ([`082b8d6`](https://github.com/Level/level-ws/commit/082b8d6)) (Vincent Weevers) +- **Breaking:** use classes, requiring `new` ([`dafafb2`](https://github.com/Level/level-ws/commit/dafafb2)) (Vincent Weevers) +- **Breaking:** drop Node.js 10 ([`817c30c`](https://github.com/Level/level-ws/commit/817c30c)) (Vincent Weevers) + +### Fixed + +- Cleanup README and add missing docs for options ([`94a2a8e`](https://github.com/Level/level-ws/commit/94a2a8e)) (Vincent Weevers). + ## [3.0.0] - 2021-04-25 -_**If you are upgrading:** please see [`UPGRADING.md`](UPGRADING.md)._ +_If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md)._ ### Changed @@ -102,6 +116,8 @@ _**If you are upgrading:** please see [`UPGRADING.md`](UPGRADING.md)._ :seedling: Initial release. +[4.0.0]: https://github.com/Level/level-ws/releases/tag/v4.0.0 + [3.0.0]: https://github.com/Level/level-ws/compare/v2.0.0...v3.0.0 [2.0.0]: https://github.com/Level/level-ws/compare/v1.0.0...v2.0.0 diff --git a/UPGRADING.md b/UPGRADING.md index 5367d60..e99416d 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -2,6 +2,22 @@ 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). +## 4.0.0 + +Drops support of Node.js 10, upgrades to `readable-stream@4` ([`082b8d6`](https://github.com/Level/level-ws/commit/082b8d6)) and uses classes which means `new` is now required. If you previously did: + +```js +const WriteStream = require('level-ws') +const ws = WriteStream(db) +``` + +You must now do: + +```js +const WriteStream = require('level-ws') +const ws = new WriteStream(db) +``` + ## 3.0.0 This release drops support of legacy runtime environments ([Level/community#98](https://github.com/Level/community/issues/98)): diff --git a/package.json b/package.json index 2d26a78..cc8f70e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "level-ws", - "version": "3.0.0", + "version": "4.0.0", "description": "A basic writable stream for abstract-level databases", "license": "MIT", "main": "level-ws.js",