Whispering‑Code 🌀 Setup

🔧 Prerequisites

Before you summon the Whispering Code, make sure the following are in place:

• Node.js ≥ 18.0.0 (or the mystical deno if you like whispers in the wind)
• Git 2.30+ (to fetch the secret verses)
• A terminal that accepts 🪄 as a valid character

🚀 Installation

Run the incantation below. Feel free to chant it thrice for extra luck.

npm install whispering-code --save
# or, if you trust the moon:
deno add https://deno.land/x/whispering_code/mod.ts

⚙️ Configuration

Create a whisper.yml at the root of your project. The file is interpreted by the code as poetry, not JSON.

tone: mellow
volume: 0.7
echo:
  enabled: true
  delay: 120ms
secret:
  phrase: "speak friend and enter"

Tip: Change tone to urgent for a more insistent whisper.

🏃‍♀️ Running Your First Whisper

In your entry file, import and invoke the core function:

import { whisper } from "whispering-code";

whisper({ message: "Hello, world!" })
  .then(() => console.log("✨ Whisper sent!"))
  .catch(err => console.error("⚡️ Whisper failed:", err));

Watch the console for a gentle sparkle. If you see nothing, try turning up the volume in whisper.yml.

🛠️ Troubleshooting

• No output? Ensure your terminal supports Unicode emojis.
• Syntax error? Remember that whisper.yml is YAML, not JSON.
• Still stuck? Visit the FAQ or summon the Dashboard for a visual aid.