aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d0f16fe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# Weekly Report Generator
+
+# Usage
+
+```
+usage: weekly [-h] [-V] [-dDy] [-]
+
+Weekly Report Generator vA.B.C
+
+Options:
+--help -h Show this usage statement
+--dump-relative -d Dump records relative to current week
+--dump-absolute -D Dump records by week value
+--dump-year -y Set dump-[relative|absolute] year
+--version -V Show version
+```