X-Git-Url: https://git.r.bdr.sh/rbdr/olden-mail/blobdiff_plain/2fdda21d13ed742bdb52ec3ba74538af83de2bf4..83b70b6cadc619c765b36406661b0b629ab3b904:/README.md?ds=inline

diff --git a/README.md b/README.md
index 9e6e407..c494ef5 100644
--- a/README.md
+++ b/README.md
@@ -56,11 +56,23 @@ This means the minimum invocation is this (Shown here with inline
 environment variables)
 
 ```
-% REMOTE_IMAP_DOMAIN=imap.coolmailsite.example REMOTE_SMTP_DOMAIN=smtp.coolmailsite.example olden-mail
+% REMOTE_IMAP_HOST=imap.coolmailsite.example REMOTE_SMTP_HOST=smtp.coolmailsite.example olden-mail
 ```
 
+## Middleware
+
+In order to work with some older clients, middleware allow transformation of
+messages. The current middleware are:
+
+- `FindMailboxesCompatibility` - Transforms IMAPv3 FIND MAILBOX commands to
+    IMAPv4 LIST commands.
+
 ## Debugging
 
 You can control how much it prints by setting `RUST_LOG`. Setting it to
 `debug` will output the whole protocol stream. The default level is
 `info`.
+
+Messages coming from the client are prefixed with `>>>`, and messages coming
+from the server with `<<<`. If a middleware modified a command, you'll see
+the message that was actually sent prefixed with `###`.