From d05d1d486e2ac9540199c1140aa00fe0e73a55cb Mon Sep 17 00:00:00 2001
From: Conrad Hoffmann <ch@bitfehler.net>
Date: Thu, 19 May 2022 12:22:41 +0200
Subject: [PATCH] Add more details to README

---
 README.md | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ad640db..e5ae594 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,31 @@
 
 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.
+
+It currently provides:
+
+Authentication:
+
+* IMAP (working)
+
+Storage:
+
+* Filesystem (working)
+* PostgreSQL (planned)
+
+[1]: https://github.com/emersion/go-webdav "go-webdav project page on Github"
+
 ## Building
 
 * `cd cmd/tokidoki && go build`
 
 ## Running
 
-Using the IMAP authentication backend and the filesystem storage backend:
+Using the IMAP authentication backend and the filesystem storage backend
+(directory must exist):
 
 * `./tokidoki -auth.url imaps://imap.example.com:993 -storage.url file:///path/to/storage -debug`