From ba224ce518fdca8168062effd1bfe473d55cbd96 Mon Sep 17 00:00:00 2001 From: Michael Clemens Date: Tue, 8 Dec 2020 01:08:26 +0100 Subject: [PATCH] added content to README --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e6604d6..802b688 100644 --- a/README.md +++ b/README.md @@ -1 +1,20 @@ -# pyBMNotify \ No newline at end of file +# pyBMNotify + +Monitors a defined set of Brandmeister talkgroups and callsigns for activity and sends push notifications via Pushover. + +## Credits + +Inspired by [https://github.com/klinquist/bmPushNotification] + +## Requirements + +* Python 3 +* socketIO-client (install with _sudo pip3 install socketIO-client_) + +## Configuration + +Configure _config.py_ to your needs. If you don't want push notifications, leave the corresponding variables empty. + +## Execution + +_# python3 pyBMNotify.py_