Skip to content

Commit 37935df

Browse files
mcollinavweevers
andauthored
v4 launch details (#472)
* fixed review Signed-off-by: Matteo Collina <[email protected]> * Update README.md Co-authored-by: Vincent Weevers <[email protected]> * Update README.md Co-authored-by: Vincent Weevers <[email protected]> Co-authored-by: Vincent Weevers <[email protected]>
1 parent 431a9af commit 37935df

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![Browsers Build](https://github.com/nodejs/readable-stream/workflows/Browsers/badge.svg)](https://github.com/nodejs/readable-stream/actions?query=workflow%3ABrowsers)
99

1010
```bash
11-
npm install --save readable-stream
11+
npm install readable-stream
1212
```
1313

1414
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
2020

2121
As of version 2.0.0 **readable-stream** uses semantic versioning.
2222

23+
## Version 4.x.x
24+
25+
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.
26+
The breaking changes introduced by v4 are composed of the combined breaking changes in:
27+
* [Node v12](https://nodejs.org/en/blog/release/v12.0.0/)
28+
* [Node v13](https://nodejs.org/en/blog/release/v13.0.0/)
29+
* [Node v14](https://nodejs.org/en/blog/release/v14.0.0/)
30+
* [Node v15](https://nodejs.org/en/blog/release/v15.0.0/)
31+
* [Node v16](https://nodejs.org/en/blog/release/v16.0.0/)
32+
* [Node v17](https://nodejs.org/en/blog/release/v17.0.0/)
33+
* [Node v18](https://nodejs.org/en/blog/release/v18.0.0/)
34+
35+
This also includes _many_ new features.
36+
2337
## Version 3.x.x
2438

2539
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
5670
functions.
5771

5872
```js
59-
const { Readable, Writable, Transform, Duplex, pipeline, finished } = require('readable-stream')
73+
const {
74+
Readable,
75+
Writable,
76+
Transform,
77+
Duplex,
78+
pipeline,
79+
finished
80+
} = require('readable-stream')
6081
```
6182

6283
Note that `require('stream')` will return `Stream`, while

0 commit comments

Comments
 (0)