diff --git a/readme.md b/readme.md index 71d9a84..8c5ba46 100644 --- a/readme.md +++ b/readme.md @@ -1,10 +1,17 @@
- -

uofgcal

+ +

UofG Calendar Sync

-### todo +The University of Glasgow's timetable ICS is locked behind authentication, preventing popular calendar apps like [Google Calendar](https://calendar.google.com/) from synchronising it. **uofgcal** is a service which acts as a proxy to the calendar file, authenticating on behalf of calendar apps that do not support authentication. + +This service is provided for all students, free-of-charge. The service can also be self-hosted, for those concerned about security - however the system is designed to be as bullet-proof as possible as it handles incredibly sensible data. + +This software is in early alpha stages, so expect many breaking changes. You can see a roadmap of what is to come below. + +### Roadmap - logging - web dashboard - key rotation +- emails for when authentication fails