docs: README per PACKAGE_GUIDELINES — fix H1 to scope, remove License/MIT sections, rename Description to Why, update Node 18→22, fix fictitious peer imports
CI / publish (push) Failing after 9s
CI / test (push) Successful in 17s

This commit is contained in:
Tenere CI
2026-07-20 14:40:10 -07:00
parent ecc03395a3
commit 7537d7fa37
2 changed files with 8 additions and 8 deletions
+3 -7
View File
@@ -1,4 +1,4 @@
# stream-to-push-stream # @push-stream-std/stream-to-push-stream
Convert native Node.js streams to push-stream source, sink, and duplex interfaces. Convert native Node.js streams to push-stream source, sink, and duplex interfaces.
@@ -41,8 +41,7 @@ npm config set -- //hub.kl1.tenere.ai/api/packages/push-stream-std/npm/:_authTok
npm install @push-stream-std/stream-to-push-stream npm install @push-stream-std/stream-to-push-stream
``` ```
## Description ## Why
Utilities for bridging between the Node.js `stream` module (Readable, Writable, Duplex) and the push-stream protocol. PushSource wraps a Readable, listening to `data`/`end`/`error` events and implementing `pipe()`, `resume()`, and `abort()`. PushSink wraps a Writable, translating `write()` calls to `writable.write()` with `drain`-based backpressure and `end()` to `writable.end()`. PushDuplex wraps a Duplex stream as a combined source/sink for bidirectional push-stream pipelines. Utilities for bridging between the Node.js `stream` module (Readable, Writable, Duplex) and the push-stream protocol. PushSource wraps a Readable, listening to `data`/`end`/`error` events and implementing `pipe()`, `resume()`, and `abort()`. PushSink wraps a Writable, translating `write()` calls to `writable.write()` with `drain`-based backpressure and `end()` to `writable.end()`. PushDuplex wraps a Duplex stream as a combined source/sink for bidirectional push-stream pipelines.
## API ## API
@@ -78,8 +77,5 @@ Tests cover readable-to-source data flow and end handling, writable-to-sink writ
## Requirements ## Requirements
Node.js 18 or later. ESM only. Node.js 22 or later. ESM only.
## License
MIT
+5 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "@push-stream-std/stream-to-push-stream", "name": "@push-stream-std/stream-to-push-stream",
"version": "1.0.1", "version": "1.0.2",
"description": "Convert Node.js streams to push-streams", "description": "Convert Node.js streams to push-streams",
"type": "module", "type": "module",
"main": "index.js", "main": "index.js",
@@ -29,5 +29,9 @@
], ],
"publishConfig": { "publishConfig": {
"registry": "https://hub.kl1.tenere.ai/api/packages/push-stream-std/npm/" "registry": "https://hub.kl1.tenere.ai/api/packages/push-stream-std/npm/"
},
"repository": {
"type": "git",
"url": "https://hub.kl1.tenere.ai/push-stream-std/stream-to-push-stream.git"
} }
} }