From c9e5549f1ed30760bac04d1e7bcec1153e258194 Mon Sep 17 00:00:00 2001
From: Yuval Adam <_@yuv.al>
Date: Thu, 13 May 2021 16:07:50 +0300
Subject: Move params around and add usage in README

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'README.md')

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.
+```
-- 
cgit v1.3.1