@winkjs/composer 0.4.1 → 0.4.2

package/README.md

@@ -6,7 +6,7 @@
 ## Composable Streaming Intelligence
 [<img align="right" src="https://decisively.github.io/wink-logos/logo-title.png" width="100px" >](https://winkjs.org/)
 
-winkComposer is a JavaScript framework for turning live data streams into insights and decisions — while the data is still moving. There is no batch job to wait for. On the plant floor, a delayed insight is a lost opportunity. It is open source, purpose-built for SMBs and MSMEs.
+winkComposer is a JavaScript framework that turns streaming data into real-time insights and decisions. The streams can come from anywhere: IoT and IIoT sensors, vehicle telematics, server metrics. There is no batch job to wait for. In real-time operations like a plant floor, a delayed insight is a lost opportunity. It is open source, purpose-built for SMBs and MSMEs.
 
 
 ## See It in Action
@@ -38,13 +38,17 @@ The Quick Start below builds one such pipeline end to end.
 
 ## Quick Start
 
+Requires Node.js 22 or newer.
+
+The Quick Start flow replays a CSV feed of pump motor temperatures. It cleans each reading, flags a hot motor, confirms the heat is not a blip, and prints an alert. One command scaffolds it as a runnable project:
+
 ```bash
-npm install @winkjs/composer
+npm create @winkjs/composer
 ```
 
-Requires Node.js 22 or newer.
+Accept the directory prompt, then run the three printed steps. A run takes about eight seconds. Watch for the `overheat` alert. Prefer zero install? [Build this flow interactively](https://composer.winkjs.org/docs/playground/hello-flow) in the browser playground. The same project also lives in the repository, in [`examples/hello-flow`](examples/hello-flow).
 
-A complete flow — replay a CSV feed, clean each reading, flag a hot pump motor, confirm it is not a blip, and print an alert:
+Here is the whole program, [`hello-flow.js`](examples/hello-flow/hello-flow.js):
 
 ```javascript
 import { flow, csv, terminal } from '@winkjs/composer';
@@ -87,9 +91,13 @@ const handle = await flow( 'hello-flow' )
     .run();
 ```
 
-The same flow ships as a runnable project in [`examples/hello-flow`](examples/hello-flow), data included. Run it with `npm install && npm start`.
+To use winkComposer in your own project:
+
+```bash
+npm install @winkjs/composer
+```
 
-Prefer zero install? [Build this flow interactively](https://composer.winkjs.org/docs/playground/hello-flow) in the browser playground.
+Your project needs `"type": "module"` in its `package.json`. Then copy the flow above and point `path` at your own data. The replayed file has two columns: a pump id and a motor temperature (`id`, `motor_t`).
 
 The example above replays a CSV file. A live deployment reads from an MQTT broker instead — or runs [headless](docs/handbook/headless-flow.md), where your own code feeds the flow. Headless takes any source you already run: an OPC-UA client, a Kafka consumer.
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@winkjs/composer",
-    "version": "0.4.1",
+    "version": "0.4.2",
     "description": "Composable Streaming Intelligence — turn streaming data into actionable insights, from edge to cloud",
     "keywords": [
         "streaming",
@@ -75,5 +75,9 @@
         "mqtt": "^5.15.1",
         "msgpackr": "^1.11.10",
         "pg": "^8.20.0"
+    },
+    "overrides": {
+        "serialize-javascript": "^7.1.0",
+        "diff": "^8.0.3"
     }
 }