newt/uofgcal
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: add content to readme

Browse source
This commit is contained in:
newt 2024-09-25 02:28:18 +01:00
parent 70cf9174a4
commit 93b8f3b28b
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
readme.md
View file

@ -1,10 +1,17 @@
<div align="center">
<img src="marquee.jpg">
<h1>uofgcal</h1>
<img src="marquee.jpg" height="175">
<h1>UofG Calendar Sync</h1>
</div>
### 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