From f890dff8b0edab00eb44dc6ddac81ecfe1d211bc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20L=C3=B8vbr=C3=B8tte=20Olsen?=
 <daniel.olsen99@gmail.com>
Date: Fri, 21 Oct 2022 19:46:39 +0200
Subject: [PATCH] Create README.MD

---
 README.MD | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.MD

diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..e76cf8b
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,34 @@
+With matrix.YOURDOMAIN pointing at the server:
+
+```
+{
+  imports = [ ./synapse-module ];
+
+  services.matrix-synapse-next = {
+    enable = true;
+
+    workers.federationSenders = 1;
+    workers.federationReceivers = 1;
+
+    enableNginx = true;
+
+    settings = {
+      server_name = "YOURDOMAIN";
+      
+      database = {
+        name = "psycopg2";
+        args = {
+          host = "localhost";
+          user = "synapse";
+          password = "synapse";
+          dbname = "synapse";
+        };
+      };
+    };
+  };
+  
+  services.redis.servers."".enable = true;
+}
+```
+
+is ~enough to get a functional matrix-server running one federation sender and one federation receiver