update README and remove lazyload

This commit is contained in:
emerson 2021-12-07 08:12:44 -05:00
parent de2fd40feb
commit ef8b6c49c7
No known key found for this signature in database
GPG key ID: 270669502DA603E3
2 changed files with 23 additions and 15 deletions

View file

@ -10,7 +10,7 @@ That said, it is usable for basic chatting.
- 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
- Built-in bouncer: Multiple IRC clients can be authenticated to a Matrix user
- Multi-user support: Log into multiple Matrix accounts, or run an instance for your community (Note: this isn't fully functional yet)
- Multi-user: Log in to multiple Matrix users at the same time
## Feature support
@ -22,16 +22,25 @@ That said, it is usable for basic chatting.
| Name | M->I | I->M | Notes |
| ---- | :--: | :--: | ----- |
| text, notice, emote messages | ✅ | ✅ ||
| image, file, audio, video messages | 🟨 | ❌ | Shows up on IRC as the link to the file |
| Channel joins | ✅ | 🟨 | Channel joining works, but the channel is always the room id |
| Channel parts | ✅ | ✅ ||
| Channel kicks | ✅ | ❌ ||
| Channel bans | 🟨 | ❌ | Show up as kicks on IRC |
| Channel topics | ✅ | ✅ ||
| Channel powers | 🟨 | ❌ | They don't show correctly if the powerlevels aren't the default |
| Message replies <small>(IRCv3)</small> | ✅ | ❌ ||
| Message reactions <small>(IRCv3)</small> | ✅ | ❌ ||
| Chathistory <small>(IRCv3)</small> | ❌ | ❌ ||
| text, notice, emote messages | ❌ | ❌ ||
| image, file, audio, video messages | ❌ | ❌ ||
| Channel joins | ❌ | ❌ ||
| Channel parts | ❌ | ❌ ||
| Channel kicks | ❌ | ❌ ||
| Channel bans | ❌ | ❌ ||
| Channel topics | ❌ | ❌ ||
| Channel powers | ❌ | ❌ ||
| Encrypted rooms | ❌ | ❌ ||
| Message replies <small>(IRCv3)</small> | ❌ | ❌ ||
| Message reactions <small>(IRCv3)</small> | ❌ | ❌ ||
| Chat history <small>(IRCv3)</small> | ❌ | ❌ ||
| Multiline messages <small>(IRCv3)</small> | ❌ | ❌ ||
| Display Names <small>(IRCv3)</small> | ❌ | ❌ ||
| Global display names <small>(IRCv3)</small> | ❌ | ❌ ||
| Per-room display names <small>(IRCv3)</small> | ❌ | ❌ ||
| Message editing/deletion <small>(IRCv3)</small> | ❌ | ❌ ||
## Running
Copy `config.example.json` to `config.json`, edit the values if needed, then `npm run build` and then `node reflection.js` to start it
## Authentication
Authentication is done via `SASL PLAIN`, the username is your mxid and the password is an access token from another session.

View file

@ -2,6 +2,5 @@
"serverName": "testing.",
"port": 6697,
"certFile": "reflection.pem",
"keyFile": "reflection.key",
"lazyJoinLimit": 100
"keyFile": "reflection.key"
}