From fd49f329f86b8231a9dff70d8d126297e91ad3c0 Mon Sep 17 00:00:00 2001
From: Filip Wandzio <contact@philw.dev>
Date: Tue, 28 Oct 2025 11:28:42 +0100
Subject: Update readme

---
 README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 46 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 451e7d6..c35dc51 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,50 @@
-# whiterabbit(1) – Manual
+# whiterabbit
 
 **Date:** 2025-10-02  
 **Version:** 1.1.0  
 **Name:** whiterabbit – auto-configure Matrix homeservers (Dendrite, Synapse, or Tuwunel)
+
+
+## About
+All Matrix homeservers share the same Coturn instance.
+TLS certificates are issued automatically via Let's Encrypt.
+Requires docker, docker-compose, nginx, certbot, and coturn.
+
+## Usage
+
+Install or configure the global Coturn server.
+
+```bash
+ wh turn <domain> <ip> <device> <secret>
+
+```
+
+Add a new Matrix Dendrite server with automatic TLS and Nginx reverse proxy.
+```bash
+ wh dendrite <domain> <email> <server_ip>
+
+```
+
+Add a new Matrix Synapse server with automatic TLS and Nginx reverse proxy.
+```bash
+ wh synapse <domain> <email> <server_ip>
+
+```
+
+Add a Tuwunel homeserver with automatic TLS and Nginx reverse proxy.
+```bash
+ wh tuwunel <domain> <email> <server_ip>
+
+```
+
+List all configured Matrix servers and their container status.
+```bash
+ wh list
+
+```
+
+Remove one or more Matrix servers by domain name.
+```bash
+ wh remove <domain_name>
+
+```
-- 
cgit v1.2.3