diff --git a/.env.sample b/.env.sample new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md new file mode 100644 index 0000000..89d8ae3 --- /dev/null +++ b/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. + +
+ +
+ +## 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 +``` diff --git a/images/logo.svg b/images/logo.svg new file mode 100644 index 0000000..f63f0f4 --- /dev/null +++ b/images/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/images/screenshot.jpg b/images/screenshot.jpg new file mode 100644 index 0000000..2a707b9 Binary files /dev/null and b/images/screenshot.jpg differ