diff --git a/README.md b/README.md new file mode 100644 index 0000000..ea2a267 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Bib Reminder for Munich public library + +This automatically sending pushover messages when a lent item is about to be returned, while also extending the period if possible. + +Configure the docker container with the following variables. + +## Docker Config + +### Required + +- `PUSHOVER_KEY` Your pushover API Key +- `PUSHOVER_CLIENTS` A comma seperated list of pushover client ids. +- `HEALTHCHECK_URL` An url for performing a healthcheck (see healthckeck.io for details) +- `BIB_USERS` A comma seperated list of combinations of : combinations to check and extend lent items. + +Example: +´´´ +PUSHOVER_KEY=abcdef1234567890abcdef12345678 +HEALTHCHECK_URL=https://healthcheck.io/ping/0000000-0000-0000-0000-000000000000 +BIB_USERS=400001234567:password,40000987654:drowssap +NOTIFY_USERS= 400001234567:12345678abcdef1234567890abcdef,40000987654:12345678abcdef1234567890abcdef +´´´ \ No newline at end of file