From 4c4e1f90274c02f039d7f4c4e15e6d7e1463dfd3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timo=20K=C3=B6sters?= Date: Tue, 20 Apr 2021 12:53:20 +0200 Subject: [PATCH] docs: update readme --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 32fa6572..292ee837 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,23 @@ example) and register on the `https://conduit.koesters.xyz` homeserver. - [Rocket](https://rocket.rs): A flexible web framework -#### What are the biggest things still missing? +#### What is the current status? -- Most federation features (invites, e2ee) -- Push notifications on mobile -- Notification settings +Conduit can already be used chat with other users on Conduit, chat with users +from other Matrix servers and even to chat with users on other platforms using +appservices. When chatting with users on the same Conduit server, everything +should work assuming you use a compatible client. + +**You should not join Matrix rooms without asking the admins first.** We do not +know whether Conduit is safe for general use yet, so you should assume there is +some chance that it breaks rooms permanently for all participating users. We +are not aware of such a bug today, but we would like to do more testing. + +There are still a few important features missing: + +- Database stability (currently you might have to do manual upgrades or even wipe the db for new versions) +- End-to-end encrypted chats over federation +- Typing, presence, read receipts etc. over federation - Lots of testing Check out the [Conduit 1.0 Release Milestone](https://gitlab.com/famedly/conduit/-/milestones/3).