From 8124ed040a960b4761c571fb4b0bf0a8cda69fb1 Mon Sep 17 00:00:00 2001 From: Ryan Mwangi <99436511+Ryanmwangi@users.noreply.github.com> Date: Thu, 10 Oct 2024 02:35:05 +0300 Subject: [PATCH] Update README.md --- README.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 94e0818..fbfd672 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,44 @@ -Calendar Merger Project -Overview +**Calendar Merger Project** +**Overview ** + The Calendar Merger project is a web application that allows users to merge multiple calendars into a single calendar. The application provides a simple and intuitive interface for users to add calendars, specify prefixes for each calendar, and override the event summaries if desired. -Features +**Features** + Merge multiple calendars into a single calendar Specify prefixes for each calendar Override event summaries if desired Generate a unique URL for the merged calendar Update the merged calendar every hour using a cron job -Requirements +**Requirements** + Node.js (version 14 or higher) Express.js (version 4 or higher) ical (version 0.7 or higher) axios (version 0.21 or higher) cron (version 1.8 or higher) -Installation +**Installation** + Clone the repository Install the dependencies using npm install Start the server using npm start -Usage +**Usage** + Open a web browser and navigate to http://localhost:3000 Click on the "Add Calendar" button to add a new calendar Enter the calendar URL, prefix, and override options as desired Click on the "Merge Calendars" button to generate the merged calendar The merged calendar URL will be displayed on the page -API Endpoints +**API Endpoints** + GET /: Returns the index.html file POST /merge: Merges the calendars and returns the merged calendar URL GET /:filename: Returns the merged calendar file -Contributing -Contributions are welcome! If you'd like to contribute to the project, please fork the repository and submit a pull request. \ No newline at end of file +**Contributing** + +Contributions are welcome! If you'd like to contribute to the project, please fork the repository and submit a pull request.