From 7a52e42555b12c2ff0d54ce25bd695978584699b Mon Sep 17 00:00:00 2001
From: G2-Games <ke0bhogsg@gmail.com>
Date: Sun, 19 Jan 2025 16:48:47 -0600
Subject: [PATCH] Added readme

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README.md b/README.md
index e69de29..dbb73d3 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,26 @@
+# Oden
+Oden Music Bot (OMB) is a Discord music bot intended to be selfhosted!
+
+## Running
+Running requires using [`uv (https://docs.astral.sh/uv/)`](https://docs.astral.sh/uv/).
+
+You also have to obtain a bot token. Follow the section of this tutorial labeled
+"Creating an app" to see how to do that:
+
+https://discord.com/developers/docs/tutorials/configuring-app-metadata-for-linked-roles#creating-an-app
+
+
+After installing `uv` and obtaining a bot token, clone the repository.
+
+```bash
+git clone https://github.com/Dangoware/oden-music-bot.git
+cd oden-music-bot
+```
+Put your bot token into an environment variable called `ODEN_DISCORD_SECRET`,
+then run the bot.
+
+```bash
+uv run oden
+```
+
+Enjoy!