summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authortimokoesters <timo@koesters.xyz>2020-07-11 09:51:58 +0200
committertimokoesters <timo@koesters.xyz>2020-07-11 09:55:44 +0200
commitf361cb3d398dd75ed1c15a9ef433ad82e0d4c7f5 (patch)
tree9fa5bdc521953cf518027b40cbdf3c3748de3387 /README.md
parent8409146415e9e7ee446e9d3d8b6c9f2f4255499b (diff)
downloadconduit-f361cb3d398dd75ed1c15a9ef433ad82e0d4c7f5.zip
Improve README
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/README.md b/README.md
index ded4844..53eb85c 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ See it in action: <https://www.youtube.com/watch?v=HoBslDtqC1k>
#### Can I try it out?
-Yes! Just open Riot (<https://riot.im/app> or RiotX) and register on the `https://conduit.koesters.xyz:14004` homeserver.
+Yes! Just open Riot (<https://riot.im/app> or RiotX for example) and register on the `https://conduit.koesters.xyz:14004` homeserver.
#### How can I deploy my own?
@@ -29,15 +29,20 @@ It's explained in more detail [here](https://git.koesters.xyz/timo/conduit/wiki/
#### What are the biggest things still missing?
-- Federation (Make Conduit talk to other Matrix servers)
-- Notifications (Make Matrix client notify the user when new messages or pings arrive)
+- Federation (Talk to other Matrix servers)
+- Appservices (Bridges and Bots)
+- Push notifications on mobile
+- Notification settings
- Lots of testing
Also check out the [milestones](https://git.koesters.xyz/timo/conduit/milestones).
#### How can I contribute?
-If you want to help, you may be able to find something in the issue tracker. If you do, comment on the issue, so others know. You can also join #conduit:matrix.org and ask there.
+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
#### Donate