Add some more infos to README

This commit is contained in:
Conrad Hoffmann 2022-12-14 15:36:07 +01:00
parent b266d53b15
commit 7b98e643e8

View File

@ -23,7 +23,8 @@ Storage:
## Building
* `cd cmd/tokidoki && go build`
* Without PAM backend: `go build ./cmd/tokidoki/`
* With PAM backend: `go build -tags pam ./cmd/tokidoki/`
## Running
@ -35,6 +36,17 @@ Using the IMAP authentication backend and the filesystem storage backend
Tokidoki does not support HTTPS at this time, use a reverse TLS proxy if
needed.
## Clients
Tokidoki does not yet support all CalDAV/CardDAV features, but tries to support
the subset to make most major clients work.
The following clients are considered "supported":
* Evolution (contacts & calendar)
* Thunderbird (calendar) with CardBook extension (contacts)
* DavX5 (contacts & calendar)
## Usage
Only a single address book and calendar per user are supported at the moment,
@ -47,3 +59,13 @@ 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
## 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].
[4]: https://sr.ht/~sircmpwn/tokidoki
[5]: mailto:~sircmpwn/tokidoki-dev@lists.sr.ht
[6]: mailto:~sircmpwn/tokidoki-discuss@lists.sr.ht