From 210cdff15e7abf08609ffb2bd8d645593ef6a1c7 Mon Sep 17 00:00:00 2001 From: Falko Zurell Date: Sun, 17 Nov 2024 20:13:13 +0100 Subject: [PATCH] updated README --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0aa480e..b3c6ae6 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,27 @@ pip install -r requirements.txt ``` +calling the script will prompt for the CSV file. +The output will be two files. One is the CSV file with the `.ics` extension, the other is a `event_uids.json` containing the unique identifier of each event line. +This will make updating the events via the CSV file easier. + +# Key Features: +- UID Persistence: +Event UIDs are stored in a JSON file (event_uids.json). +If the event key (based on description, date, start time, and location) exists, the same UID is reused. +- LAST-MODIFIED Field: +The last_modified timestamp is added to each event, ensuring updates are detected by calendar applications. +- Resilience to Changes: +If an event's details are modified in the CSV, the application recognizes it as an update due to the persistent UID. +# Benefits: +Consistent Updates: Calendar applications update events with matching UIDs rather than creating duplicates. +Persistence: Even if the script is rerun, previously assigned UIDs remain consistent. + ## example CSV file format ``` -Host;Description;Date;start time;end time;Location +Gastgeber;Description;Date;start time;end time;Location Max Müller;Team Meeting;20.11.2024;10:00;11:00;Berlin Anna Löwe;Project Kickoff;21.11.2024;09:00;10:30;München ```