summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2021-05-13 16:01:26 +0300
committerYuval Adam <_@yuv.al>2021-05-13 16:01:26 +0300
commitd745708d1239ae05144b520935618931aa4525a0 (patch)
tree81857b05a0699304ba1472099880794fa995eaf9
parent76cb8d764b888b1ebc1a8dd6b152ba4809df930e (diff)
Add README
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c0f14fc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# Pikud HaOref Alarm Tracking
+
+A simple CLI tool for tracking Pikud HaOref alarms.
+
+## Usage
+
+```bash
+$ pipenv sync
+$ pipenv run alarmpy
+```