easter-egg-quest 1.0.0 → 1.0.2

package/README.md

@@ -1,23 +1,26 @@
 # 🥚 Easter Egg Quest
 
-Drop a hidden Easter-themed mini-game onto **any website** with a single line of code. Users discover a secret entry point on your page and solve three poetic riddles — *Stillness*, *Motion*, *Rhythm* — to collect three symbolic eggs.
+Something is hiding on your website. Your visitors don't know it yet.
 
-**Zero configuration required.** The game overlays your page without breaking layout. Fully self-contained — Three.js 3D rendering is built in.
+One line of code — and your page holds a secret. A poetic journey disguised as ordinary text. Three riddles. Three eggs. One question: *will they notice?*
 
-## Quick Start
+No buttons. No banners. No hints. Just a quiet invitation woven into the fabric of your page.
 
-### CDN (simplest)
+Those who find it will never look at your website the same way again.
+
+---
+
+## Installation
+
+### One line (CDN)
 
 ```html
-<script src="https://unpkg.com/easter-egg-quest"></script>
-<script>
-  EasterEggQuest.init();
-</script>
+<script src="https://unpkg.com/easter-egg-quest/dist/easter-egg-quest.umd.js"></script>
 ```
 
-That's it. The game hides itself inside your page content and waits to be discovered.
+Nothing else needed. The script activates itself after your page loads.
 
-### npm
+### npm / yarn
 
 ```bash
 npm install easter-egg-quest
@@ -29,59 +32,50 @@ import { EasterEggQuest } from 'easter-egg-quest';
 EasterEggQuest.init();
 ```
 
-## How It Works
+---
+
+## What happens next?
+
+That's for your visitors to discover.
+
+We'll only say this: the experience has three chapters, each asking something different. Something about stillness. Something about motion. Something about the space between.
 
-1. **Hidden entry** — the game injects a subtle "start hunt" trigger into existing text on your page
-2. **Stage 1: Stillness** — stop moving. The egg comes to those who wait
-3. **Stage 2: Motion** — keep moving. Be the river
-4. **Stage 3: Rhythm** — find the pulse. Breathe
-5. **Finale** — all three eggs appear in a 3D carousel with a "Happy Easter!" greeting
-6. **Results** — a personalized profile card based on your behavior (shareable as image)
+The whole thing takes a few minutes. At the end, each person gets a unique result — a portrait of how they moved through the unknown.
 
-The user clicks "finish" to close — the game removes all traces of itself from the DOM.
+---
 
 ## Configuration
 
-All options are optional:
+Everything works out of the box. But if you want control:
 
 ```js
 EasterEggQuest.init({
-  // Lifecycle callbacks
   callbacks: {
-    onInit: () => {},
-    onEntryFound: () => {},
-    onStageStart: (stage) => {},
-    onEggFound: (eggIndex) => {},
-    onComplete: (score) => {},
-    onDestroy: () => {},
+    onComplete: (score) => {
+      // The visitor finished the quest
+    },
   },
 
-  // Stage durations
   stageDurations: {
     stillnessMs: 20000,
     motionMs: 20000,
     rhythmCycles: 6,
   },
 
-  // Rendering: 'auto' | '3d' | '2d'
-  renderer: 'auto',
+  renderer: 'auto',          // 'auto' | '3d' | '2d'
 
-  // Accessibility
   accessibility: {
-    reducedMotion: 'auto',   // follows prefers-reduced-motion
-    disableHiddenEntry: false, // shows a visible button instead
+    reducedMotion: 'auto',
+    disableHiddenEntry: false,
   },
 
-  // Hidden entry targeting
   hiddenEntry: {
-    selector: undefined,       // CSS selector to limit entry candidates
-    excludeSelectors: [],      // selectors to exclude
+    selector: undefined,
+    excludeSelectors: [],
   },
 
-  // Custom narrative text
   narrative: {
-    // Override any dialogue array:
-    // stage1Intro: ['your', 'custom', 'lines'],
+    // Your own words for any chapter
   },
 });
 ```
@@ -89,26 +83,26 @@ EasterEggQuest.init({
 ## API
 
 ```js
-EasterEggQuest.init(config?)   // Start the game
-EasterEggQuest.pause()         // Pause
-EasterEggQuest.resume()        // Resume
-EasterEggQuest.destroy()       // Remove everything, restore DOM
+EasterEggQuest.init(config?)   // Awaken the quest
+EasterEggQuest.pause()         // Freeze time
+EasterEggQuest.resume()        // Let it breathe again
+EasterEggQuest.destroy()       // Erase all traces
 ```
 
-## Safety
+---
 
-Designed to be safe on production websites:
+## Safe by design
 
-- **No layout shifts** — all UI is `position: fixed` overlay
-- **Shadow DOM isolation** — CSS never collides with your styles
-- **Smart element filtering** — hidden entry avoids Buy, Delete, Checkout, Submit buttons
-- **Clean destroy** — removes all DOM elements, listeners, and WebGL resources
+- Your layout stays untouched — everything floats above
+- Styles are sealed in Shadow DOM — no collisions
+- Dangerous buttons (Buy, Delete, Submit) are never used as entry points
+- `destroy()` leaves your page exactly as it was
 
-## Browser Support
+## Compatibility
 
-Chrome/Edge 90+ · Firefox 90+ · Safari 15+ · Mobile browsers
+Chrome · Edge · Firefox · Safari · Mobile
 
-Falls back to CSS 2D rendering if WebGL is unavailable.
+Falls back gracefully without WebGL.
 
 ## License