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 +++++++++++++++
 alarmpy.py | 10 +++++++---
 2 files changed, 22 insertions(+), 3 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.
+```
diff --git a/alarmpy.py b/alarmpy.py
index b55e82e..73a73fd 100644
--- a/alarmpy.py
+++ b/alarmpy.py
@@ -62,12 +62,16 @@ class Alarm(object):
 
 @click.command()
 @click.option("--delay", default=1, help="Polling delay in seconds")
-@click.option("--alarm-id", is_flag=True, help="Print alarm ID")
 @click.option(
     "--routine-delay", default=60 * 5, help="Routine message delay in seconds"
 )
-def alarm(delay, alarm_id, routine_delay):
-    Alarm(delay=delay, alarm_id=alarm_id, routine_delay=routine_delay).start()
+@click.option("--alarm-id", is_flag=True, help="Print alarm ID")
+def alarm(delay=1, routine_delay=60 * 5, alarm_id=False):
+    Alarm(
+        delay=delay,
+        routine_delay=routine_delay,
+        alarm_id=alarm_id,
+    ).start()
 
 
 if __name__ == "__main__":
-- 
cgit v1.3.1