~sircmpwn/tokidoki

536f83fa6144b2f64919206ef08bcb56663c10f8 — Conrad Hoffmann 4 months ago a74c768
Update README to reflect the multi-resource update
1 files changed, 15 insertions(+), 14 deletions(-)

M README.md
M README.md => README.md +15 -14
@@ 4,8 4,9 @@ Tokidoki is a (WIP) carddav and caldav server.

## Architecture

Tokidoki relies on [go-webdav][1] for the protocol implementation. It provides
the storage backend and authentication, both of which are easily pluggable.
Tokidoki relies on [go-webdav][go-webdav] for the protocol implementation. It
provides the storage backend and authentication, both of which are easily
pluggable.

It currently provides:



@@ 19,7 20,7 @@ Storage:
* Filesystem (working)
* PostgreSQL (planned)

[1]: https://github.com/emersion/go-webdav "go-webdav project page on Github"
[go-webdav]: https://github.com/emersion/go-webdav "go-webdav project page on Github"

## Building



@@ 60,23 61,23 @@ The following clients are considered "supported":

## Usage

Only a single address book and calendar per user are supported at the moment,
this is currently a [limitation in go-webdav][2].
Currently, by default only a single address book and calendar per user are
supported, as users cannot create new ones. If additional resources are created
manually on the server, tokidoki will however serve them just fine.

Tokidoki supports calendar and address book auto-discovery via
`/.well-known/caldav` and `/.well-known/carddav` respectively, as defined in
[RFC 6764, section 6][3]. Hence, most clients should be able to discover
[RFC 6764, section 6][rfc]. Hence, most clients should be able to discover
resources by just pointing them at the server root.

[2]: https://github.com/emersion/go-webdav/issues/26
[3]: https://datatracker.ietf.org/doc/html/rfc6764#section-6
[rfc]: https://datatracker.ietf.org/doc/html/rfc6764#section-6

## Contact

See the [tokidoki project page][4] for up-to-date information. Patches can be
submitted to the [tokidoki-devel mailing list][5]. For general discussion,
please use the [tokidoki-discuss mailing list][6].
See the [tokidoki project page][project] for up-to-date information. Patches can be
submitted to the [tokidoki-devel mailing list][devel-list]. For general discussion,
please use the [tokidoki-discuss mailing list][discuss-list].

[4]: https://sr.ht/~sircmpwn/tokidoki
[5]: mailto:~sircmpwn/tokidoki-dev@lists.sr.ht
[6]: mailto:~sircmpwn/tokidoki-discuss@lists.sr.ht
[project]: https://sr.ht/~sircmpwn/tokidoki
[devel-list]: mailto:~sircmpwn/tokidoki-dev@lists.sr.ht
[discuss-list]: mailto:~sircmpwn/tokidoki-discuss@lists.sr.ht