From 5a2e7a10134b10fd773cdb8aa79e2a6f3f45296e Mon Sep 17 00:00:00 2001
From: shy <shy@posteo.de>
Date: Sun, 18 Apr 2021 10:18:31 +0200
Subject: [PATCH] Added readme.

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..262b3fd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+Simple timing application for text terminals. Helper for preparing tea,
+coffee, pasta etc.
+
+Single large up-counting clock with optional alarm times. Alarm times may
+be given as command line arguments, read from stdin or entered interactively.
+
+
+    USAGE: kitchentimer [-h|-v] [-e|--exec COMMAND] [-p] [-q] [ALARM[/LABEL]]
+
+    PARAMETERS:
+      [ALARM TIME[/LABEL]]  Any number of alarm times (HH:MM:SS) with optional
+                            label.
+
+    OPTIONS:
+      -h, --help            Show this help.
+      -v, --version         Show version information.
+      -e, --exec [COMMAND]  Execute COMMAND on alarm. Occurrences of {t} will
+                            be replaced by the alarm time in (HH:)MM:SS format.
+                            Occurrences of {l} by alarm label.
+      -p, --plain           Use simpler block chars to draw the clock.
+      -f, --fancy           Make use of less common unicode characters.
+      -q, --quit            Quit program after last alarm.
+
+    SIGNALS: <SIGUSR1> Reset clock.
+             <SIGUSR2> Pause or un-pause clock.
+