From 3b3bfcb14b5c43ba495cd2becf4277b1c1e3080c Mon Sep 17 00:00:00 2001 From: Filip Wandzio Date: Fri, 26 Sep 2025 00:10:33 +0200 Subject: Update readme --- README | 19 ------------------- README.md | 13 +++++++++++++ 2 files changed, 13 insertions(+), 19 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 7a2e496..0000000 --- a/README +++ /dev/null @@ -1,19 +0,0 @@ -whiterabbit -Auto-configure Matrix homeservers (Dendrite or Synapse) -with a global Coturn server, Nginx, and Let's Encrypt. - -Commands: - -turn Install or configure the global Coturn server -dendrite Add a new Matrix server (Dendrite) -synapse Add a new Matrix server (Synapse) -list Show all configured Matrix servers -remove Remove a Matrix server by domain - -Examples: - -./whiterabbit.sh turn -./whiterabbit.sh dendrite -./whiterabbit.sh synapse -./whiterabbit.sh list -./whiterabbit.sh remove matrix.example.com diff --git a/README.md b/README.md new file mode 100644 index 0000000..48bb23c --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# whiterabbit + +**Auto-configure Matrix homeservers** (Dendrite or Synapse) + +with a global Coturn server, Nginx, and Let's Encrypt. + +## Commands + +| Command | Description | +|------------|-------------| +| `turn` | Install or configure the global Coturn server | +| `dendrite` | Add a new Matrix server (Dendrite) | +| `synapse` | Add a new Matrix server (Synapse) | -- cgit v1.2.3