From 12437a82505b84db97a5f4b34ede5a0132a0bfd7 Mon Sep 17 00:00:00 2001 From: emerson Date: Mon, 3 Jul 2023 19:04:25 +0000 Subject: [PATCH] update readme --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0f186ce..74e365f 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ ReflectionIRCd is an IRCd that bridges Matrix, allowing you to use an IRC client ## Why? -This is for people who want to use their existing IRC client to talk on Matrix channels, without needing a working bridge or existing IRC network. I also wanted to use it on all homeservers without needing special privileges. +This is for people who want to use their existing IRC client to talk on Matrix channels, without needing a working bridge or existing IRC network. I also wanted to use it on all homeservers without needing special privileges. You'll probably always need another Matrix client on hand for doing administrative things, media uploading, and Element-specific things, but it works great for general chatting. -Also, it's an easy way to develop new IRCv3 features for both clients and servers, pushing forward IRC development so clients can have feature parity with Matrix clients. +Also, I'm using it as an easy way to develop new IRCv3 features for both clients and servers ## Running @@ -44,7 +44,7 @@ Then `npm ci`, `npm run build`, and `node reflection.js configs/matrix.json` (re * You can't open a PM to individual users, since a "PM" in Matrix is just another room, and you can't join rooms from IRC. * There's no IRC equivalent to Spaces (yet). Since they are just regular rooms, they show up in IRC as just regular rooms, however, you can't send messages to them. * In order to highlight users, you need to prefix their nick with an `@`, so `@emerson: hi`. Reflection automatically expands this to the user's MXID, so even though it's annoying, it's needed to stop inadvertent highlights for now. -* In general, Reflection trusts IRC clients to do the right thing, and doesn't have a lot of error-checking of IRC messages (it does have robust error checking for the Matrix side because Matrix sends a lot of error-filled messages). +* Read receipts aren't synced to other clients ## Compatibility