From 96b8feff5e40aa8078a5bc53bbb6057141465826 Mon Sep 17 00:00:00 2001 From: daladim Date: Tue, 23 Nov 2021 23:32:09 +0100 Subject: [PATCH] [doc] --- README.md | 3 +++ src/lib.rs | 5 +++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index efca90e..163197b 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,9 @@ kitchen-fridge is a CalDAV (iCal file transfer over WebDAV) Rust client library. +CalDAV is described as "Calendaring Extensions to WebDAV" in [RFC 4791](https://datatracker.ietf.org/doc/html/rfc4791) and [RFC 7986](https://datatracker.ietf.org/doc/html/rfc7986) and the underlying iCal format is described at least in [RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545). \ +This library has been intensivley tested with Nextcloud servers. It should support Owncloud and iCloud as well, since they use the very same CalDAV protocol. + Its [documentation](https://docs.rs/kitchen-fridge/) is available on docs.rs. diff --git a/src/lib.rs b/src/lib.rs index 216f331..caf145c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,5 +1,6 @@ -//! This crate provides a CalDAV client. -//! CalDAV is described as "Calendaring Extensions to WebDAV" in [RFC 4791](https://datatracker.ietf.org/doc/html/rfc4791) and [RFC 7986](https://datatracker.ietf.org/doc/html/rfc7986) and the underlying iCal format is described at least in [RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545). +//! This crate provides a CalDAV client library. \ +//! CalDAV is described as "Calendaring Extensions to WebDAV" in [RFC 4791](https://datatracker.ietf.org/doc/html/rfc4791) and [RFC 7986](https://datatracker.ietf.org/doc/html/rfc7986) and the underlying iCal format is described at least in [RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545). \ +//! This library has been intensivley tested with Nextcloud servers. It should support Owncloud and iCloud as well, since they use the very same CalDAV protocol. //! //! This initial implementation only supports TODO events. This it can fetch and update a CalDAV-hosted todo-list...just like [sticky notes on a kitchen fridge](https://www.google.com/search?q=kitchen+fridge+todo+list&tbm=isch) would. \ //! Supporting other items (and especially regular CalDAV calendar events) should be fairly trivial, as it should boil down to adding little logic in iCal files parsing, but any help is appreciated :-)