diff --git a/README.md b/README.md index c14f1fa..703a4ef 100644 --- a/README.md +++ b/README.md @@ -21,4 +21,4 @@ Currently, I'm considering the following Capturers (based on my own life): - [ ] [Steam Capturer](design/steam.md) - [ ] [Netflix](design/netflix.md) - [ ] [Deezer](design/deezer.md) -- [ ] Calendar/CalDav +- [ ] [Calendar/CalDav](design/caldav.md) diff --git a/design/caldav.md b/design/caldav.md new file mode 100644 index 0000000..a3f3fdf --- /dev/null +++ b/design/caldav.md @@ -0,0 +1,25 @@ +# CalDav Capturer + +The CalDav capturer captures new events in a calendar. + +CalDav uses the [iCalendar](https://en.wikipedia.org/wiki/ICalendar) format. + +## Configuration + +The CalDav capturer needs the URL for the CalDav. + +## Internals + +There is no single event ID, so we need to keep the DSTART and DEND as unique +identifiers of each event. New events are the ones not in this list. + +- `dstart`: Event start. +- `end`: Event end. + +## Output + +``` +{% for event in new_events %} +Have a new event: {{ event.description }} +{% endfor %} +```