Update README.md

This commit is contained in:
Clarence Chan committed 2024-08-08 16:43:54 -04:00
1 parent ef8fe2b74f
commit 43362bd5bc
2 files changed
+28

No files matched your search

+28
View File
@@ -5,3 +5,31 @@
Or subscribe manually from your calendar app: Or subscribe manually from your calendar app:
`webcal://raw.githubusercontent.com/clarencechaan/ufc-cal/ics/UFC.ics` `webcal://raw.githubusercontent.com/clarencechaan/ufc-cal/ics/UFC.ics`
## What is this?
A calendar feed you can subscribe to in order to have UFC events automatically added to your calendar app of choice, as each event gets announced and updated over time.
This feed is not affiliated with the UFC.
## Why is it better than other feeds?
The three biggest points that this aims to address, which I found lacking in other calendar feeds:
- **Always kept up to date**: events are added and card details are updated within a day of the UFC posting an event or adding/removing fights to/from a previously announced event
- **Event times are accurate**: event times reflect your local timezone, and always match the times posted by the UFC
- **Card details**: without leaving your calendar, you can see every (announced) fight on the card, whether it's on the main card, prelims, or early prelims
## Example event
![Example event](./ufc-cal-example.png)
## Info for nerds
**How does it work?**
- Using a GitHub Action, the UFC's website is scraped several times each day, and the `UFC.ics` file (from the URL above) is updated with any new information found
**To run locally:**
- Clone this repo, run the command `npm start`, and out spits your `UFC.ics` file with all the relevant UFC events
Binary file not shown.

After

Width:  |  Height:  |  Size: 193 KiB