From ce94ad05a7a1bcc6e861ca4d8e51395e4ee4e5af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timo=20K=C3=B6sters?= Date: Sun, 18 Oct 2020 13:23:06 +0200 Subject: [PATCH] Update README.md --- README.md | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 44ab0d69..48b51ae7 100644 --- a/README.md +++ b/README.md @@ -6,22 +6,22 @@ #### What is the goal? -A fast Matrix homeserver that's easy to set up and just works. You can install it on a mini-computer like the Raspberry Pi to host Matrix for your family, friends or company. - -#### Is it fast? - -See it in action: +A fast Matrix homeserver that's easy to set up and just works. You can install +it on a mini-computer like the Raspberry Pi to host Matrix for your family, +friends or company. #### Can I try it out? -Yes! Just open a Matrix client ( or Element Android for example) and register on the `https://conduit.koesters.xyz` homeserver. +Yes! Just open a Matrix client ( or Element Android for +example) and register on the `https://conduit.koesters.xyz` homeserver. #### How can I deploy my own? ##### From source Clone the repo, build it with `cargo build --release` and call the binary -(target/release/conduit) from somewhere like a systemd script. [Read more](DEPLOY_FROM_SOURCE.md) +(target/release/conduit) from somewhere like a systemd script. [Read +more](DEPLOY_FROM_SOURCE.md) ##### Using Docker @@ -36,14 +36,16 @@ Or build and run it with docker or docker-compose. [Read more](docker/README.md) #### What is it build on? -- [Ruma](https://www.ruma.io): Useful structures for endpoint requests and responses that can be (de)serialized -- [Sled](https://github.com/spacejam/sled): A simple (key, value) database with good performance +- [Ruma](https://www.ruma.io): Useful structures for endpoint requests and + responses that can be (de)serialized +- [Sled](https://github.com/spacejam/sled): A simple (key, value) database with + good performance - [Rocket](https://rocket.rs): A flexible web framework #### What are the biggest things still missing? -- Federation (Talk to other Matrix servers) - Appservices (Bridges and Bots) +- Most federation features (invites, e2ee) - Push notifications on mobile - Notification settings - Lots of testing @@ -52,8 +54,10 @@ Also check out the [milestones](https://git.koesters.xyz/timo/conduit/milestones #### How can I contribute? -1. Look for an issue you would like to work on and make sure it's not assigned to other users -2. Ask someone to assign the issue to you (comment on the issue or chat in #conduit:matrix.org) +1. Look for an issue you would like to work on and make sure it's not assigned + to other users +2. Ask someone to assign the issue to you (comment on the issue or chat in + #conduit:matrix.org) 3. Fork the repo and work on the issue. #conduit:matrix.org is happy to help :) 4. Submit a PR