summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorParthiv Seetharaman <pachum99@myrdd.info>2022-04-23 23:51:09 -0700
committerParthiv Seetharaman <pachum99@myrdd.info>2022-04-23 23:51:09 -0700
commit5483c1b3f73c81a4533a1d7a8cc80486ca9b5c14 (patch)
tree462b19fa18efac9fd142ef93c157f9fca8f0f08f
parentff782189f05f48f28a8292b0e3c9bb579ebe93e5 (diff)
README: Add status section
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7f28e9e..bea4690 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,10 @@ If you would like the module to configure synapse or dendrite to
include all appservice registration files you can just set:
`services.matrix-appservices.addRegistrationFiles = true`.
+## Status
+I consider the module stable enough to use on my own server. Many of the packages available through the module are not stable.
+Any appservice listed in the examples folder has been tested to work with this module. Optimally this module will work with non-tested appservices, but there are likely still quirks that haven't been dealt with. If you have any issues or get another appservice to work, please let me know with an issue or by chat.
+
## Configuring
There are many options available to configure the way each appservice
is setup. But to consolidate similarities, there are three formats