summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8206232..5112027 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,24 @@
A simple CLI tool for tracking Pikud Ha'oref alarms.
+Polls the unofficial API endpoint every second for incoming alarms. Prints active alarms as they occur. Prints routine messages once every 5 minutes by default.
+
## Usage
```bash
$ pipenv sync
$ pipenv run alarmpy
```
+
+Advanced flags can be set as described in the usage:
+
+```bash
+$ pipenv run alarmpy --help
+Usage: alarmpy.py [OPTIONS]
+
+Options:
+ --delay INTEGER Polling delay in seconds
+ --routine-delay INTEGER Routine message delay in seconds
+ --alarm-id Print alarm ID
+ --help Show this message and exit.
+```