From 01535ab341ecddba1b8852192409a4638488d645 Mon Sep 17 00:00:00 2001
From: srgooglo <srgooglo@ragestudio.net>
Date: Sat, 8 Oct 2022 23:15:45 +0200
Subject: [PATCH] added readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6c4348b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# Remote Soundpad Bot
+### For real soundpad users enjoyers
+
+This is a bot for Discord that allows you to play sound from a URL to a remote machine.
+
+## Requirements (Only tested on linux)
+- NodeJS >= 14
+- ffmpeg
+- yt-dlp
+- mpg123
+
+## Installation
+- Clone the repository
+- Install the dependencies with `npm install` or `yarn install`
+- Copy the `.env-example` file to `.env` and fill the fields
+  > You will need to create a Discord application and a bot user for it. You can find more 
+  information about it [here](https://discordjs.guide/preparations/setting-up-a-bot-application.html).
+- Run the bot with `npm start` or `yarn start`