Add README.md

Signed-off-by: Abdulkadir Furkan Şanlı <me@abdulocra.cy>
This commit is contained in:
Abdulkadir Furkan Şanlı 2024-01-19 14:10:50 +01:00
parent de133d4aed
commit 67c365a62c
Signed by: afk
SSH Key Fingerprint: SHA256:s1hULLl4YWdqU501MUfGe1CAG/m1pf9Cs6vFsqeTNHk

18
README.md Normal file
View File

@ -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`