From bc7d4c3c92f814179adc1656dd7e5da6d6a5bb88 Mon Sep 17 00:00:00 2001
From: 3wc <3wc.git@doesthisthing.work>
Date: Tue, 2 Mar 2021 18:38:38 +0200
Subject: [PATCH] Follow new exciting README standard

See coop-cloud/organising#31
---
 README.md | 37 +++++++++++++++++++++++--------------
 1 file changed, 23 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index d24f149..0389d12 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,27 @@
-# Matrix Synapse
+# Matrix (Synapse)
 
-Matrix Synapse, based on the [official `matrixdotorg/synapse`
-image][synapse-docker].
+<!-- metadata -->
+* **Category**: Apps
+* **Status**: ❹💣
+* **Image**: [`matrixdotorg/synapse`](https://hub.docker.com/r/matrixdotorg/synapse), ❶💚, upstream
+* **Healthcheck**: Yes
+* **Backups**: No
+* **Email**: No
+* **Tests**: ❷💛
+* **SSO**: No
+<!-- endmetadata -->
 
-1. Set up Docker Swarm and [`abra`][abra]
-2. Deploy [`compose-stacks/traefik`][compose-traefik]
-2. `cp .envrc.sample .envrc`
-3. Edit `.envrc` - be sure to change `$DOMAIN` to something that resolves to
+## Basic usage
+
+1. Set up Docker Swarm and [`abra`]
+2. Deploy [`compose-stacks/traefik`]
+3. `abra app new adaptauthoring --secrets` (optionally with `--pass` if you'd like
+   to save secrets in `pass`)
+4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to
    your Docker swarm box
-4. `direnv allow` (or `. .envrc`)
-5. `abra deploy`
-6. `abra service_run synapse` to open a shell
-7. `register_new_matrix_user -c /data/homeserver.yaml http://localhost:8008`
+5. `abra app YOURAPPDOMAIN deploy`
+6. Create an initial user:
+   `abra app YOURAPPDOMAIN run app register_new_matrix_user -c /data/homeserver.yaml http://localhost:8008`
 
-[synapse-docker]: https://hub.docker.com/r/matrixdotorg/synapse
-[abra]: https://git.autonomic.zone/autonomic-cooperative/abra
-[compose-traefik]: https://git.autonomic.zone/compose-stacks/traefik
+[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
+[`compose-stacks/traefik`]: https://git.autonomic.zone/compose-stacks/traefik