From ef8b6c49c71ccbb280f86d0bc603ff3e286c4079 Mon Sep 17 00:00:00 2001
From: emerson <git@emersonveenstra.net>
Date: Tue, 7 Dec 2021 08:12:44 -0500
Subject: [PATCH] update README and remove lazyload

---
 README.md           | 35 ++++++++++++++++++++++-------------
 config.example.json |  3 +--
 2 files changed, 23 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index fc3c82e..3d98127 100644
--- a/README.md
+++ b/README.md
@@ -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> | ❌ | ❌ ||
\ No newline at end of file
+| 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.
\ No newline at end of file
diff --git a/config.example.json b/config.example.json
index 5c0ee4d..6296e87 100644
--- a/config.example.json
+++ b/config.example.json
@@ -2,6 +2,5 @@
     "serverName": "testing.",
     "port": 6697,
     "certFile": "reflection.pem",
-    "keyFile": "reflection.key",
-    "lazyJoinLimit": 100
+    "keyFile": "reflection.key"
 }
\ No newline at end of file