📝 Add README

README.md

@@ -0,0 +1,27 @@
+# Timetable V2 Notify
+
+A [Matrix](https://matrix.org/) bot for [Timetable V2](https://gitlab.minie4.de/minie4/timetable-v2) to notify users when the substitution plan changes.
+
+<div align="center">
+<img src="images/logo.svg" width="100" height="100">
+</div>
+
+## Screnshot
+
+![Screenshot](images/screenshot.jpg)
+
+## Setup using docker
+
+Build the docker image
+
+```sh
+docker build -t timetable-v2-notify .
+```
+
+Copy the `.env.sample` to `.env` and change the values as required.
+
+Run the docker image
+
+```sh
+docker run -d --name timetable-v2-notify -v timetable-v2-notify-data:/app/data --restart unless-stopped timetable-v2-notify
+```

images/logo.svg

@@ -0,0 +1 @@
+<svg xmlns:xlink="http://www.w3.org/1999/xlink" width="512" xmlns="http://www.w3.org/2000/svg" height="512" id="screenshot-4f977952-786c-800d-8002-b5a2bb5bb558" viewBox="0 0 512 512" style="-webkit-print-color-adjust: exact;" fill="none" version="1.1"><g id="shape-4f977952-786c-800d-8002-b5a2bb5bb558"><defs><clipPath class="frame-clip-def frame-clip" id="frame-clip-4f977952-786c-800d-8002-b5a2bb5bb558-rumext-id-1"><rect rx="0" ry="0" x="0" y="0" width="512" height="512" transform=""/></clipPath></defs><g clip-path="url(#frame-clip-4f977952-786c-800d-8002-b5a2bb5bb558-rumext-id-1)"><clipPath class="frame-clip-def frame-clip" id="frame-clip-4f977952-786c-800d-8002-b5a2bb5bb558-rumext-id-1"><rect rx="0" ry="0" x="0" y="0" width="512" height="512" transform=""/></clipPath><g class="fills" id="fills-4f977952-786c-800d-8002-b5a2bb5bb558"><rect rx="0" ry="0" x="0" y="0" transform="" width="512" height="512" class="frame-background"/></g><g class="frame-children"><g id="shape-4f977952-786c-800d-8002-b5a2bb5bb559"><g class="fills" id="fills-4f977952-786c-800d-8002-b5a2bb5bb559"><rect rx="50" ry="50" x="0" y="0" transform="" width="512" height="512" style="fill: rgb(53, 53, 53); fill-opacity: 1;"/></g><g id="strokes-4f977952-786c-800d-8002-b5a2bb5bb559" class="strokes"><g class="stroke-shape"><rect rx="50" ry="50" x="0" y="0" transform="" width="512" height="512" style="fill: none;"/></g></g></g><g id="shape-4f977952-786c-800d-8002-b5a2bb5bb55a" rx="0" ry="0" style="opacity: 0.3;"><g id="shape-4f977952-786c-800d-8002-b5a2bb5bb55c" rx="0" ry="0"><g id="shape-4f977952-786c-800d-8002-b5a2bb5bb55f" rx="0" ry="0"><g id="shape-4f977952-786c-800d-8002-b5a2bb5bb560"><g class="fills" id="fills-4f977952-786c-800d-8002-b5a2bb5bb560"><rect rx="5" ry="5" x="147.25" y="340.93836805555566" transform="" width="319" height="77" style="fill: rgb(20, 88, 126); fill-opacity: 1;"/></g><g id="strokes-4f977952-786c-800d-8002-b5a2bb5bb560" class="strokes"><g class="stroke-shape"><rect rx="5" ry="5" x="147.25" y="340.93836805555566" transform="" width="319" height="77" style="fill: none;"/></g></g></g><g id="shape-4f977952-786c-800d-8002-b5a2bb5bb561"><g class="fills" id="fills-4f977952-786c-800d-8002-b5a2bb5bb561"><rect rx="5" ry="5" x="46.25" y="340.93836805555566" transform="" width="77" height="77" style="fill: rgb(20, 88, 126); fill-opacity: 1;"/></g><g id="strokes-4f977952-786c-800d-8002-b5a2bb5bb561" class="strokes"><g class="stroke-shape"><rect rx="5" ry="5" x="46.25" y="340.93836805555566" transform="" width="77" height="77" style="fill: none;"/></g></g></g></g></g><g id="shape-4f977952-786c-800d-8002-b5a2bb5bb55d" rx="0" ry="0"><g id="shape-4f977952-786c-800d-8002-b5a2bb5bb562" rx="0" ry="0"><g id="shape-4f977952-786c-800d-8002-b5a2bb5bb563"><g class="fills" id="fills-4f977952-786c-800d-8002-b5a2bb5bb563"><rect rx="5" ry="5" x="146.75" y="216.7465277777776" transform="" width="319" height="77" style="fill: rgb(20, 88, 126); fill-opacity: 1;"/></g><g id="strokes-4f977952-786c-800d-8002-b5a2bb5bb563" class="strokes"><g class="stroke-shape"><rect rx="5" ry="5" x="146.75" y="216.7465277777776" transform="" width="319" height="77" style="fill: none;"/></g></g></g><g id="shape-4f977952-786c-800d-8002-b5a2bb5bb564"><g class="fills" id="fills-4f977952-786c-800d-8002-b5a2bb5bb564"><rect rx="5" ry="5" x="45.75" y="216.7465277777776" transform="" width="77" height="77" style="fill: rgb(20, 88, 126); fill-opacity: 1;"/></g><g id="strokes-4f977952-786c-800d-8002-b5a2bb5bb564" class="strokes"><g class="stroke-shape"><rect rx="5" ry="5" x="45.75" y="216.7465277777776" transform="" width="77" height="77" style="fill: none;"/></g></g></g></g></g><g id="shape-4f977952-786c-800d-8002-b5a2bb5bb55e" rx="0" ry="0"><g id="shape-4f977952-786c-800d-8002-b5a2bb5bb565" rx="0" ry="0"><g id="shape-4f977952-786c-800d-8002-b5a2bb5bb566"><g class="fills" id="fills-4f977952-786c-800d-8002-b5a2bb5bb566"><rect rx="5" ry="5" x="146.75" y="94.06163194444434" transform="" width="319" height="77" style="fill: rgb(125, 43, 45); fill-opacity: 1;"/></g><g id="strokes-4f977952-786c-800d-8002-b5a2bb5bb566" class="strokes"><g class="stroke-shape"><rect rx="5" ry="5" x="146.75" y="94.06163194444434" transform="" width="319" height="77" style="fill: none;"/></g></g></g><g id="shape-4f977952-786c-800d-8002-b5a2bb5bb567"><g class="fills" id="fills-4f977952-786c-800d-8002-b5a2bb5bb567"><rect rx="5" ry="5" x="45.75" y="94.06163194444434" transform="" width="77" height="77" style="fill: rgb(125, 43, 45); fill-opacity: 1;"/></g><g id="strokes-4f977952-786c-800d-8002-b5a2bb5bb567" class="strokes"><g class="stroke-shape"><rect rx="5" ry="5" x="45.75" y="94.06163194444434" transform="" width="77" height="77" style="fill: none;"/></g></g></g></g></g></g><g id="shape-4f977952-786c-800d-8002-b5a2d8991da0" width="24" class="lucide lucide-bell" height="24" rx="0" ry="0" filter="url(#filter_rumext-id-16)" style="fill: rgb(0, 0, 0);"><defs><filter id="filter_rumext-id-16" x="-0.08653846153846Line truncated