diff --git a/README.md b/README.md index 25df51ac8..eff533687 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,38 @@ -# olympics-calendar +# Olympics Calendar +This repository contains a script to generate calendar files (.ics) for the Paris 2024 Summer Olympic Games, allowing you to sync sports events with your Google Calendar. -I couldn't find anywhere a calendar that I could sync with my google calendar for sports/teams I'm interested in so I made a script that generates ics files and open-sourced it. +## Features +- **Automatic Updates**: Calendars update automatically during the event. +- **Customizable**: Select specific sports or teams you're interested in. +- **Easy Integration**: Sync directly with Google Calendar using provided URLs. -All calendars are available here: https://fabrice404.github.io/olympics-calendar/ +## Installation +1. Clone the repository: -They will be automatically updated during the event, so better to use the URL instead of downloading the files. +```bash +git clone https://github.com/fabrice404/olympics-calendar.git +cd olympics-calendar +``` + +2. Install dependencies: + +```bash +Copy code +npm install +``` + +3. Generate the calendar files: + +```bash +Copy code +node index.js +``` + +## Usage +All calendar files are available at this URL. Use the provided URLs to sync with your Google Calendar instead of downloading the files. + +## Contribution +Contributions are welcome! Feel free to open issues or submit pull requests. + +## License +This project is licensed under the MIT License.