From 8525f6b364860fbc00a4ab869612a61239cf8ec5 Mon Sep 17 00:00:00 2001 From: Bernhard B Date: Tue, 11 May 2021 18:43:25 +0200 Subject: [PATCH] improved README see #129 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 3e8e606..ca1aa56 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,8 @@ services: [signal-cli](https://github.com/AsamK/signal-cli), which this REST API wrapper is based on, recommends to call `receive` on a regular basis. So, if you are not already calling the `receive` endpoint regularily, it is recommended to set the `AUTO_RECEIVE_SCHEDULE` parameter in the docker-compose.yml file. The `AUTO_RECEIVE_SCHEDULE` accepts cron schedule expressions and automatically calls the `receive` endpoint at the given time. e.g: `0 22 * * *` calls `receive` daily at 10pm. If you are not familiar with cron schedule expressions, you can use this [website](https://crontab.guru). +**WARNING** Calling `receive` will fetch all the messages for the registered Signal number from the Signal Server! So, if you are using the REST API for receiving messages, it's _not_ a good idea to use the `AUTO_RECEIVE_SCHEDULE` parameter, as you might lose some messages that way. + ## Native Image (EXPERIMENTAL)