From 473cd71a9c35866c0767453e109fcded3a5e51c3 Mon Sep 17 00:00:00 2001
From: Yuzu <yuzu@kirameki.cafe>
Date: Fri, 21 Jun 2024 12:31:57 +0700
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20docs:=20Update=20README.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 75 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 07b0e64..1a4dfda 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,75 @@
-# NekoMelody
-🎶 NekoMelody「ねこメロディ」・‎ ‎ [WIP] Cute and versatile audio streaming package
+# 🎶 NekoMelody「ねこメロディ」
+
+NekoMelody is an audio streaming package designed to stream from YouTube and other sources. Whether you're building a Discord music bot or simply a standalone program. NekoMelody plans to includes search functionality to find songs using keywords, a queue system, and basic music player controls.
+
+> [!CAUTION]
+> This package is still in development, expect breaking changes, and may not be stable. Use with caution.
+
+# Example
+
+```ts
+import NekoMelody, { Player } from "../src";
+
+import Speaker from "speaker";
+import ffmpeg from "fluent-ffmpeg";
+import { YtDlpProvider } from "../src/providers";
+
+const main = async () => {
+    const videoId = "oi8ArKYLwBY";
+
+    // Providers
+    const providers = [new YtDlpProvider()];
+    const player = NekoMelody.createPlayer(providers);
+
+    await player.play(`https://www.youtube.com/watch?v=${videoId}`);
+    playSpeaker(player);
+};
+
+// TODO: player end event to automate changing the stream
+let lastFFmpeg: ffmpeg.FfmpegCommand | null = null;
+let lastSpeaker: Speaker | null = null;
+const playSpeaker = async (player: Player) => {
+    if (!player.stream) {
+        console.error("No input stream");
+        return;
+    }
+
+    // A function that resolves when the speaker is closed and the ffmpeg process is killed
+    const closeSpeaker = () => {
+        return new Promise<void>((resolve) => {
+            if (lastSpeaker) {
+                lastSpeaker.on("close", () => {
+                    resolve();
+                });
+                if (lastFFmpeg) lastFFmpeg.kill("SIGKILL");
+                lastSpeaker.close(true);
+            } else {
+                resolve();
+            }
+        });
+    };
+
+    await closeSpeaker();
+
+    // Create the Speaker instance
+    const speaker = new Speaker();
+    lastSpeaker = speaker;
+
+    // PCM data from stdin gets piped into the speaker
+    const ffmpegProcess = ffmpeg()
+        .input(player.stream)
+        .format("s16le") // Output format (PCM 16-bit little-endian)
+        .audioChannels(2)
+        .audioFrequency(44100)
+        .on("error", (err) => {
+            console.error("An error occurred:", err.message);
+        });
+
+    // Pipe the ffmpeg output to the speaker
+    ffmpegProcess.pipe(speaker, { end: true });
+
+    lastFFmpeg = ffmpegProcess;
+};
+
+main();
+```