From eedef73fa594fcfb4b1b3df5e76c9d70eabad64e Mon Sep 17 00:00:00 2001
From: Struck713 <noahstruck71303@gmail.com>
Date: Thu, 22 Feb 2024 19:32:28 -0500
Subject: [PATCH] Added README.md

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..174b42a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# music-bot
+
+A bot that can play music! It's as simple as it sounds.
+
+### Config
+
+If you are self-hosting this bot, you need to do some configuration:
+
+- You will need to have a YTDLP binary installed for this to work, you can get one [here](https://github.com/yt-dlp/yt-dlp/releases).
+- Once you configure (below), you can run `/deploy` to deploy all of the slash commands to the bot.
+
+```JSON
+{
+    "token": "Your discord bot token",
+    "development": {
+        "application_id": "Your application ID",
+        "guild_id": "Your guild"
+    },
+    "youtube": {
+        "api_key": "Youtube API key",
+        "binary_path": "Absolute path to YTDLP"
+    }
+}
+```
+
+### Extra features
+
+This bot can also:
+
+- Generate memes with the `/meme` command
+- Oobinate (change all vowels of a word to oob) with the `/oob` command
+- More dumb stuff I will later
\ No newline at end of file