From 161d1ed3607b73eb4f873c54ec6e00d07aa7cea2 Mon Sep 17 00:00:00 2001 From: Daniel Olsen Date: Thu, 21 Sep 2023 20:37:01 +0200 Subject: [PATCH] document some breaking changes --- MIGRATIONS.MD | 10 ++++++++++ README.MD | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 MIGRATIONS.MD diff --git a/MIGRATIONS.MD b/MIGRATIONS.MD new file mode 100644 index 0000000..342a45e --- /dev/null +++ b/MIGRATIONS.MD @@ -0,0 +1,10 @@ +# Migrations + +This is a best effort document descibing neccecary changes you might have to do when updating + +## 0.5.0 UNRELEASED + +The module has been renamed from `synapse` to `default` + + + diff --git a/README.MD b/README.MD index 0874d6c..fa9ce25 100644 --- a/README.MD +++ b/README.MD @@ -50,5 +50,5 @@ matrix-synapse.sliding-sync.environmentFile = "/some/file/containing/SYNCV3_SECR ``` -If using well-known delagation make sure `YOURDOMAIN/.well-known/matrix/client` matches +If using [well-known delagation](https://matrix-org.github.io/synapse/v1.37/delegate.html) make sure `YOURDOMAIN/.well-known/matrix/client` matches what's in `matrix.YOURDOMAIN/.well-known/matrix/client`