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`