aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRuben Pollan2018-12-10 16:55:27 +0100
committerRuben Pollan2018-12-10 16:55:27 +0100
commita45cf07e92b58f29aa88413a30d921edba48872f (patch)
treee2b80f0bcfabafa98642d59c59aba2718b9b0725 /README.md
parentfe1fab184fac5beb1bc222ff46bcd6a32f20990d (diff)
Update readme and usage
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index 45ed09e..c8ee994 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,17 @@
# Almanac
-Simple .ics parser to print the following events on the command line.
+Simple .ics parser to pretty print the events on the terminal.
+
+## Usage
+
+```
+$ almanac week personal.ics other.ics
+
+Mon Dec 10 2018
+ 17:00-18:00 event 1
+
+Wed Dec 12 2018
+ ----------- all day event
+ description
+ 19:00-20:00 nother event
+```