Skip to content

Commit

Permalink
Added README.md
Browse files Browse the repository at this point in the history
- Fixes #1
  • Loading branch information
Diegomcha committed Sep 15, 2023
1 parent b9da883 commit 60f3c09
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# 📅 EIICAL

> An API wrapper for the EII Schedule webpage which adds additional functionality such as ical format.
## Routes

| Variables | Format | Example |
| ------------------- | :-------: | -----------------------: |
| Year | `y1-y2` | `23-24` - Year 2023-2024 |
| Semester | `sx` | `s1` - First semester |
| University username | `UOxxxxx` | `UO294054` |

#### MAIN

> eiical.diegomcha.workers.dev/**cal**/**y1-y2**/**sx**/**UOxxxxx**
Redirects the user to the official user page:
![Page where the user is redirected](images/image.png)

#### CSV

> eiical.diegomcha.workers.dev/**cal**/**y1-y2**/**sx**/**UOxxxxx**/**csv**
Downloads the user calendar in CSV format. This file is generated by the official page.

#### ICAL

> eiical.diegomcha.workers.dev/**cal**/**y1-y2**/**sx**/**UOxxxxx**/**ical**
Downloads the user calendar in ICAL format. This file is generated by the from the official CSV. This calendar can be subscribed to.

## Caching

- [**AFFECTS ALL ROUTES!**] **Groups** to which each user belong are cached for **a week**.

- **ICAL** calendar is cached for **12h**.
- The rest of the routes dont implement a cache.
Binary file added images/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 60f3c09

Please sign in to comment.