add readme

Signed-off-by: Mattias Andrée <maandree@operamail.com>

1 files changed, 15 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..8778b5c
--- /dev/null
+++ b/README
@@ -0,0 +1,15 @@
+Schedule an alarm for a program when starting it.
+
+
+USAGE: alarm <TIME> <COMMAND> <ARGS...>
+
+Recognised patterns for <TIME>:
+
+    <SECONDS>[s]
+    <MINUTES>m[<SECONDS>s]
+    <HOURS>h[<MINUTES>m][<SECONDS>s]
+
+    All values are non-negative integers, and
+    the interal must be greater than zero and
+    at most 18h12m15s.
+