From 0950ec772ee90535df9d77a81a48442468b5db56 Mon Sep 17 00:00:00 2001 From: ryan Date: Thu, 10 Apr 2025 18:04:51 +0300 Subject: [PATCH] docs(README): document the directory and files calmerger writes to --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 59a61fd..5aeed8f 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,17 @@ The application also generates a unique URL for the merged calendar and updates - Generate a unique URL for the merged calendar - Automatically update the merged calendar every hour +## Calender Directory + +#### `calendar/` (MERGED_CALENDARS_DIR) +- Location: Created in application's current working directory +- Purpose: Stores all generated calendar files +- Contains: + - `.ics` files - Final merged calendars in iCalendar format + - `.json` files - Configuration preserving original merge parameters + - Maintains both formats for each merged calendar group + + ## Requirements - [Node.js](https://nodejs.org/) (version 14 or higher)