From eb0eb2d02297d1c6d61451f1a96586151304ed76 Mon Sep 17 00:00:00 2001
From: just n <n@noreply.localhost>
Date: Sat, 13 Dec 2025 19:03:33 +0000
Subject: [PATCH] Update README.md

---
 README.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 49 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index d8c34bd..6a8bdcf 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,52 @@
 
 Experimental music bot for xmpp similar to discord music bots
 
-# TODO
-## Upload the source code
-### Add a lot of Alastor (Radio Demon) easter eggs from Hazbin Hotel
\ No newline at end of file
+# How to install
+
+I do not remember most details about dependencies but I will try to make an install guide.
+
+## Dependencies
+The bot highly relies on the ffmpeg binary for audio. Also having an up to date version of yt-dlp helps a lot..
+
+## Installation
+Clone the projects or just copy the scripts over.
+
+## Set up the Python Environment
+I have used venv since it is what I know.
+
+```bash
+python3 -m venv venv
+```
+
+## pip install 
+Literally
+
+```bash
+pip install slixmpp aiortc aiohttp av mutagen yt-dlp slixmpp-omemo omemo dnspython
+```
+
+I am not sure if dnspython is necessary but just in case. 
+
+## Create Directories
+Create the folder structure for music and downloads:
+```bash
+mkdir -p music/downloads
+```
+
+## Configuration
+
+Take a look at file named `config.ini` in the bot folder. Edit it (every config has their descriptions near them).
+
+## Run the Bot
+
+### Manual Start
+```bash
+# Ensure you are in your python environment
+python3 xmpp_radio_bot.py
+```
+
+
+
+## Usage
+
+The bot mostly uses **OMEMO encrypted messages**. You may need to "Trust" the bot's fingerprint in your client (Gajim/Conversations/Dino) for commands to work if encryption is active. Plaintext works too but I do not check it mostly since OMEMO is good anyways.
\ No newline at end of file