📝 Add README

This commit is contained in:
2023-06-23 20:54:21 +02:00
parent 2a2852f5dd
commit b0e1fa39fa
4 changed files with 28 additions and 0 deletions

0
.env.sample Normal file
View File

27
README.md Normal file
View File

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

1
images/logo.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 8.1 KiB

BIN
images/screenshot.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB