Update readme

This commit is contained in:
emerson 2023-07-03 18:27:24 +00:00
parent 2e7582e6c6
commit cb870740fc

View file

@ -1,11 +1,12 @@
# ReflectionIRCd
ReflectionIRCd is an IRCd that bridges Matrix, allowing you to use an IRC client to chat on Matrix. See the [support matrix](#feature-support) (pun intended) for what it can do. The issue tracker is here: https://todo.sr.ht/~emerson/reflectionircd
ReflectionIRCd is an IRCd that bridges Matrix, allowing you to use an IRC client to chat on Matrix from any homeserver. See the [support matrix](#feature-support) (pun intended) for what it can do. The issue tracker is here: https://todo.sr.ht/~emerson/reflectionircd
## Highlights
## Why?
- IRC first: The goal is for modern IRC clients to have feature parity with any other Matrix client
- Standalone: Uses the Client-Server API, so you can use it with any homeserver
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.
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.
## Running
@ -50,7 +51,7 @@ Then `npm ci`, `npm run build`, and `node reflection.js configs/matrix.json` (re
Because Matrix and IRC are open protocols, there's no way for me to test every single implementation, so here's a list of what I test on. If you see a bug in a specific Matrix or IRC client, please join the [support channel](#support) and report it. If it's a closed instance, please DM/PM me a login and I'll look into it.
### Matrix
Reflection implements features straight from the Client-Server spec, so any homeserver that conforms to the specification will be compatible. I only test Synapse right now, if you know of an open Dendrite or Conduit homeserver, let me know!
Reflection implements features straight from the Client-Server spec, so any homeserver that conforms to the specification will be compatible. I only test Synapse right now, if you know of a Dendrite or Conduit homeserver I can create an account on, let me know!
### IRC
I regularly test on Weechat, Gamja (using Soju), and The Lounge. Any actively maintained IRC client will be able to have basic functionality, although no free IRC clients currently support things like reactions, message editing/deleting, and channel renaming. If you're using multiple clients, it's best to use a bouncer like Soju to connect to Reflection, and then connect your clients to Soju.
@ -78,10 +79,10 @@ The matrix sync is set with a timeout of 15 seconds (configurable in millisecond
### Why is there a random JSON object in my console?
That means you were sent an event type that I didn't know existed. Please hop into [the chat](#support) and tell me what the `type` value is.
## Support
The main chat is `#reflectionircd` on Libera ([webchat](https://web.libera.chat/gamja/?channel=#reflectionircd)), which is available on Matrix at [`#reflectionircd:matrix.org`](https://matrix.to/#/#reflectionircd:matrix.org). Testing channels are `#reflectionircd-test` on Libera, `#reflectionircd-test:matrix.org` (portal to Libera), and `#reflection-matrix-test:matrix.org` (not linked to IRC). Please test in the testing channels and not in the main channel.
## Support channel
[`#reflectionircd:matrix.org`](https://matrix.to/#/#reflectionircd:matrix.org)
On Libera I'm `emerson`, on Matrix I'm `@emersonveenstra:matrix.org`, feel free to ping me in the channel with any questions/bug reports/complaints.
I'm `@emersonveenstra:matrix.org`, feel free to ping me in the channel with any questions/bug reports/complaints.
## Feature support