1 files changed, 8 insertions, 0 deletions

diff --git a/README b/README
index c37fae2..8872703 100644
--- a/README
+++ b/README
@@ -1,5 +1,13 @@
 CGIT-CADDY CONTAINER
 
+Cgit with automatic HTTPS (cgit + caddy + Let's Encrypt).
+
+Requirements:
+    - Public IPv4 address pointed to this machine
+    - /git directory on host for bare git repos
+    - Domain name pointing to the public IP
+TLS certificates are auto-generated by Caddy and stored in a container volume.
+
 Build:
     podman build -t cgit-caddy .