Skip to content

Commit

Permalink
change name
Browse files Browse the repository at this point in the history
  • Loading branch information
zwhitchcox committed Sep 17, 2021
1 parent 6bb8338 commit 44eb2fa
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
9 changes: 4 additions & 5 deletions README.md
@@ -1,4 +1,4 @@
# @balena/stream-adapters
# stream-adapters

WhatWG web streams and conversion utilities for node.js, browser-ready.

Expand All @@ -13,21 +13,20 @@ without the `WebStream API`, you will need the polyfills:
* stream-browserify
* web-streams-polyfill

This code is mostly taken the [node internals](https://github.com/nodejs/node/blob/master/lib/internal/webstreams/adapters.js), and just made to work on both browser and server.
This code is mostly taken the [node internals](https://github.com/nodejs/node/blob/master/lib/internal/webstreams/adapters.js), and just made to work on both browser and server. All credit should go to @jasnell for the code written here.

Note: This is an experimental api built on top of another experimental api. Use with caution.



## Installation
```
npm install @balena/stream-adapters
npm install stream-adapters
```

with peer dependencies:

```
npm install @balena/stream-adapters stream-browserify web-streams-polyfill
npm install --savea-dev stream-adapters stream-browserify web-streams-polyfill
```

## Usage
Expand Down
4 changes: 2 additions & 2 deletions package.json
@@ -1,5 +1,5 @@
{
"name": "@balena/stream-adapters",
"name": "stream-adapters",
"version": "0.0.1",
"description": "WhatWG web streams and Node stream conversion utilities for node.js",
"main": "index.js",
Expand All @@ -21,7 +21,7 @@
"author": "Zane Hitchcox <zwhitchcox@gmail.com>",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/balena-io-modules/stream-adapters/issues"
"url": "https://github.com/zwhitchcox/stream-adapters/issues"
},
"peerDependencies": {
"stream-browserify": "^3.0.0",
Expand Down

0 comments on commit 44eb2fa

Please sign in to comment.