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

2026-07-20 14:40:10 -07:00
parent ecc03395a3
commit 7537d7fa37
2 changed files with 8 additions and 8 deletions
@@ -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.

@@ -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
 ```

-## 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.

 ## API
@@ -78,8 +77,5 @@ Tests cover readable-to-source data flow and end handling, writable-to-sink writ

 ## Requirements

-Node.js 18 or later. ESM only.
+Node.js 22 or later. ESM only.

-## License
-
-MIT