particle-overlay 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,80 @@
+# particle-overlay 🌌
+
+A high-performance, off-thread particle overlay rendering engine for the web. Powered by a WebAssembly physics core compiled from Rust, it runs entirely inside a Web Worker using `OffscreenCanvas`, ensuring your main UI thread never drops a frame.
+
+---
+
+## 🚀 Features
+
+*   **Zero Main-Thread Blocking**: All physics ticks and Canvas 2D paint commands are executed off-thread inside a Web Worker.
+*   **Rust/WASM Physics**: Particle movements, swings, and speeds are computed in compiled WebAssembly.
+*   **Zero-Copy Memory Sharing**: JavaScript reads coordinate floats directly from the WASM linear memory heap.
+*   **Pre-built Presets**: Includes 12 overlays out-of-the-box (Rain, Falling Hearts, Snow, Matrix Rain, Bubbles, etc.).
+
+---
+
+## 📦 Installation
+
+```bash
+npm install particle-overlay
+```
+
+---
+
+## 🛠️ Quick Start
+
+Place a `<canvas>` element in your HTML:
+
+```html
+<canvas id="effects-canvas" style="position: absolute; inset: 0; width: 100%; height: 100%; pointer-events: none;"></canvas>
+```
+
+Mount your desired particle overlay:
+
+```javascript
+import { ParticleOverlayHost } from 'particle-overlay';
+
+const canvas = document.getElementById('effects-canvas');
+
+// Start the rain effect
+const overlay = new ParticleOverlayHost(canvas, 'rain-shower', {
+  density: 80,
+  speed: 14,
+  size: 2.25,
+  color: '#aedbf0'
+});
+
+// Update parameters dynamically
+overlay.updateParams({
+  density: 120,
+  speed: 18
+});
+
+// Terminate the effect and clean up the worker
+// overlay.destroy();
+```
+
+---
+
+## 🎨 Included Presets
+
+You can pass any of these IDs to `ParticleOverlayHost`:
+
+*   `rain-shower` - Continuous rain with bottom splashes.
+*   `falling-hearts` - Floating hearts with swaying rotations.
+*   `snow-fall` - Wobbling snowflakes.
+*   `floating-bubbles` - Rising bubbles.
+*   `thunderstorm` - Heavy storm with lightning flashes.
+*   `fireworks` - Explosive color bursts.
+*   `starry-night` - Twinkling stars and shooting stars.
+*   `drifting-clouds` - Soft moving clouds.
+*   `matrix-rain` - Cascading digital code columns.
+*   `sakura-petals` - Fluttering cherry blossoms.
+*   `moonlight` - Crescent moon, glowing light beams, and dust.
+*   `autumn-leaves` - Wind-swept swaying leaves.
+
+---
+
+## 📄 License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "particle-overlay",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "High-performance, off-thread particle overlay engine using WebAssembly and Web Workers",
   "main": "host.js",
   "type": "module",
@@ -11,6 +11,7 @@
     "host.js",
     "worker.js",
     "presets.json",
+    "README.md",
     "dist/particle_overlay.wasm"
   ],
   "keywords": [