From 67c365a62cd08bd1ef48ab4ea30c6d0504fd618d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Abdulkadir=20Furkan=20=C5=9Eanl=C4=B1?= <me@abdulocra.cy>
Date: Fri, 19 Jan 2024 14:10:50 +0100
Subject: [PATCH] Add README.md
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Abdulkadir Furkan Şanlı <me@abdulocra.cy>
---
 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..5226db7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# ParkerBot
+
+ParkerBot is a Matrix bot that monitors a channel for YouTube links and
+generates weekly playlists from them.
+
+## Installation
+
+1. Clone the repo
+2. Install the dependencies, preferably in a venv:
+  ```shell
+  python -m venv venv
+  source ./venv/bin/activate
+  pip3 install -r requirements.txt
+  ```
+
+## Running
+
+1. Execute `main.py`: `./main.py`