From 54d0e5b91595bb3a5b00b68e4f5c4c19f079bfd8 Mon Sep 17 00:00:00 2001 From: Matteo Collina Date: Tue, 24 May 2022 12:45:33 +0200 Subject: [PATCH 1/3] fixed review Signed-off-by: Matteo Collina --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6731b46a4..ab00be4db 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ [![Browsers Build](https://github.com/nodejs/readable-stream/workflows/Browsers/badge.svg)](https://github.com/nodejs/readable-stream/actions?query=workflow%3ABrowsers) ```bash -npm install --save readable-stream +npm install readable-stream ``` This package is a mirror of the streams implementations in Node.js 18.0.0. @@ -20,6 +20,20 @@ Node you, or the users of your libraries are using, use **readable-stream** _onl As of version 2.0.0 **readable-stream** uses semantic versioning. +## Version 4.x.x + +v4.x.x of `readable-stream` is a cut from Node 18. This version supports Node 12, 14, 16 and 18, as well as evergreen browsers. +The breaking changes introduced by v4 are composed by the combined breaking changes in +* [Node v12](https://nodejs.org/en/blog/release/v12.0.0/) +* [Node v13](https://nodejs.org/en/blog/release/v13.0.0/) +* [Node v14](https://nodejs.org/en/blog/release/v14.0.0/) +* [Node v15](https://nodejs.org/en/blog/release/v15.0.0/) +* [Node v16](https://nodejs.org/en/blog/release/v16.0.0/) +* [Node v17](https://nodejs.org/en/blog/release/v17.0.0/) +* [Node v18](https://nodejs.org/en/blog/release/v18.0.0/) + +This also include _many_ new features. + ## Version 3.x.x v3.x.x of `readable-stream` is a cut from Node 10. This version supports Node 6, 8, and 10, as well as evergreen browsers, IE 11 and latest Safari. The breaking changes introduced by v3 are composed by the combined breaking changes in [Node v9](https://nodejs.org/en/blog/release/v9.0.0/) and [Node v10](https://nodejs.org/en/blog/release/v10.0.0/), as follows: @@ -56,7 +70,14 @@ without any changes, if you are just using one of the main classes and functions. ```js -const { Readable, Writable, Transform, Duplex, pipeline, finished } = require('readable-stream') +const { + Readable, + Writable, + Transform, + Duplex, + pipeline, + finished +} = require('readable-stream') ``` Note that `require('stream')` will return `Stream`, while From f4c679f951f47cb331917ec777588338bcee72f1 Mon Sep 17 00:00:00 2001 From: Matteo Collina Date: Sat, 4 Jun 2022 16:23:29 +0200 Subject: [PATCH 2/3] Update README.md Co-authored-by: Vincent Weevers --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ab00be4db..fdc2a390b 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ As of version 2.0.0 **readable-stream** uses semantic versioning. ## Version 4.x.x v4.x.x of `readable-stream` is a cut from Node 18. This version supports Node 12, 14, 16 and 18, as well as evergreen browsers. -The breaking changes introduced by v4 are composed by the combined breaking changes in +The breaking changes introduced by v4 are composed of the combined breaking changes in: * [Node v12](https://nodejs.org/en/blog/release/v12.0.0/) * [Node v13](https://nodejs.org/en/blog/release/v13.0.0/) * [Node v14](https://nodejs.org/en/blog/release/v14.0.0/) From 54af20a398114a2a8771ff1b94b2d197fe72372d Mon Sep 17 00:00:00 2001 From: Matteo Collina Date: Sat, 4 Jun 2022 16:23:35 +0200 Subject: [PATCH 3/3] Update README.md Co-authored-by: Vincent Weevers --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fdc2a390b..e74a02001 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ The breaking changes introduced by v4 are composed of the combined breaking chan * [Node v17](https://nodejs.org/en/blog/release/v17.0.0/) * [Node v18](https://nodejs.org/en/blog/release/v18.0.0/) -This also include _many_ new features. +This also includes _many_ new features. ## Version 3.x.x