From a620f71f458d1ed3cadbae5305a6569920549b72 Mon Sep 17 00:00:00 2001 From: Michael Clemens Date: Tue, 8 Dec 2020 14:31:06 +0100 Subject: [PATCH] updated readme --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2d64d8e..a91ba69 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # pyBMNotify -Monitors a defined set of Brandmeister talkgroups and callsigns for activity. It then sends push notifications via Pushover for any transmission in / of the monitored talk groups / call signs. +Monitors a defined set of Brandmeister talkgroups and callsigns for activity. It then sends push notifications via Pushover and/or Telegram for any transmission in / of the monitored talk groups / call signs. In order to prevent message flooding, the script only notifes you again after 300 (configurable) seconds of silence in a TG or from a monitored call sign. @@ -13,6 +13,11 @@ Inspired by https://github.com/klinquist/bmPushNotification * Python 3 * socketIO-client (install with _sudo pip3 install socketIO-client_) +If you want to be notified via Telegram, the following libraries need to be installed: + + * telebot (install with _telebot_) + * telethon (install with _telethon_) + ## Configuration Configure _config.py_ to your needs. If you don't want push notifications, leave the corresponding variables empty.