From c713522736a54bcdf7a200449a8b208343725cff Mon Sep 17 00:00:00 2001
From: bjoernf <bjoern.foersterling@web.de>
Date: Wed, 30 Aug 2023 18:05:48 +0200
Subject: [PATCH] updated readme

---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ee8ed74..7a71ee4 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
 **Note: .ics files from Microsoft Outlook will NOT be supported!**
 
-Show upcoming events of an .ics file.
+Show upcoming events of an .ics file.\
+(primarily for ics files from `Gnome Evolution`)
 
 ```
 make run
@@ -16,6 +17,20 @@ make
 sudo make install
 ```
 
+#### usage
+
+the default path is for evolution ics files at `~/.local/share/evolution/calendar/system/calendar.ics`
+```
+ics_analyzer
+```
+
+for a custom path
+```
+ics_analyzer -f path/to/ics/file.ics
+```
+
+
+
 #### uninstall
 
 ```
@@ -24,6 +39,9 @@ sudo make uninstall
 
 #### TODO
 
+- option to add events (evolution does not care about duplicate uuids)
+(but use libuuid to create uuids)
 - add option to print upcoming events only until a certain date
 - improve makefile
+- rename executable to ics_cli
 - tests