aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTill Faelligen <tfaelligen@gmail.com>2022-04-24 20:26:20 +0200
committerTill Faelligen <tfaelligen@gmail.com>2022-04-24 20:26:20 +0200
commit67fb086c13b6845e6a76ab89d314895306e14e96 (patch)
treedf18ad0cca475ca2c3dd86c2133442ee2c6d0fda /README.md
parent6d78c4d67d5096f5bb2c7cd56f15ab79949edc86 (diff)
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index cbb35ad5..75c827c3 100644
--- a/README.md
+++ b/README.md
@@ -6,11 +6,11 @@ It intends to provide an **efficient**, **reliable** and **scalable** alternativ
- Efficient: A small memory footprint with better baseline performance than an out-of-the-box Synapse.
- Reliable: Implements the Matrix specification as written, using the
- [same test suite](https://github.com/matrix-org/sytest) as Synapse as well as
- a [brand new Go test suite](https://github.com/matrix-org/complement).
+ [same test suite](https://github.com/matrix-org/sytest) as Synapse as well as
+ a [brand new Go test suite](https://github.com/matrix-org/complement).
- Scalable: can run on multiple machines and eventually scale to massive homeserver deployments.
-As of October 2020, Dendrite has now entered **beta** which means:
+As of October 2020 (current [progress below](#progress)), Dendrite has now entered **beta** which means:
- Dendrite is ready for early adopters. We recommend running in Monolith mode with a PostgreSQL database.
- Dendrite has periodic semver releases. We intend to release new versions as we land significant features.
@@ -21,7 +21,7 @@ This does not mean:
- Dendrite is bug-free. It has not yet been battle-tested in the real world and so will be error prone initially.
- All of the CS/Federation APIs are implemented. We are tracking progress via a script called 'Are We Synapse Yet?'. In particular,
- presence and push notifications are entirely missing from Dendrite. See [CHANGES.md](CHANGES.md) for updates.
+ presence and push notifications are entirely missing from Dendrite. See [CHANGES.md](CHANGES.md) for updates.
- Dendrite is ready for massive homeserver deployments. You cannot shard each microservice, only run each one on a different machine.
Currently, we expect Dendrite to function well for small (10s/100s of users) homeserver deployments as well as P2P Matrix nodes in-browser or on mobile devices.
@@ -78,7 +78,7 @@ $ ./bin/dendrite-monolith-server --tls-cert server.crt --tls-key server.key --co
Then point your favourite Matrix client at `http://localhost:8008` or `https://localhost:8448`.
-## Progress
+## <a id="progress"></a> Progress
We use a script called Are We Synapse Yet which checks Sytest compliance rates. Sytest is a black-box homeserver
test rig with around 900 tests. The script works out how many of these tests are passing on Dendrite and it