From bb9aef0d44f88a1eeff2dc2036817f316020b723 Mon Sep 17 00:00:00 2001
From: Ville Ranki <ville.ranki@iki.fi>
Date: Sun, 3 Jan 2021 21:01:51 +0200
Subject: [PATCH] Updated README with Riot->Element and end user documentation

---
 README.md | 25 +++++++++++++++++++++----
 1 file changed, 21 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 940b88f..2849142 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ A bridge between [Matrix](http://matrix.org/) and [Discord](https://discordapp.c
 Currently the bridge is in **Beta** and quite usable for everyday
 bridging, with one or two bugs cropping up.
 
-![Screenshot of Riot and Discord working together](screenshot.png)
+![Screenshot of Element and Discord working together](screenshot.png)
 
 
 ## Helping out
@@ -88,8 +88,8 @@ file. The metrics will be reported under the URL provided in the registration fi
 #### 3PID Protocol Support
 
 This bridge support searching for rooms within networks via the 3pid system
-used in clients like [Riot](https://riot.im). Any new servers/guilds you bridge
-should show up in the network list on Riot and other clients.
+used in clients like [Element](https://app.element.io/). Any new servers/guilds you bridge
+should show up in the network list on Element and other clients.
 
 ### Setting up Discord
 
@@ -99,7 +99,7 @@ should show up in the network list on Riot and other clients.
 * Give this link to owners of the guilds you plan to bridge.
 * Finally, you can join a room with ``#_discord_guildid_channelid``
   * These can be taken from the url ("/$GUILDID/$CHANNELID") when you are in a channel.
-  * Riot (and other clients with third party protocol support) users can directly join channels from the room directory.
+  * Element (and other clients with third party protocol support) users can directly join channels from the room directory.
 * You can use Webhooks to make messages relayed by the bridge not nested by the bot user. This will also display the avatar of the user speaking on matrix with their messages.
   * The bot should create this automatically, but if not perform the following:
     * Enable ``Manage Webhooks`` on the role added by the bot.
@@ -113,6 +113,23 @@ should show up in the network list on Riot and other clients.
 
 [Howto](./docs/howto.md)
 
+## End User Documentation
+
+### Bridging a Room
+
+You must get an authorization link from bridge owner. You must be a server admin or get
+help from server admin on Discord side.
+
+* Invite the Matrix side bot to your room and wait for it to join.
+* On Discord side use the authorization link to invite bot to Discord server.
+* Find out a serverid and channelid for your server/channel you want to bridge. Search the web for instructions.
+* In Matrix room give command ``!discord bridge ServerID ChannelID``
+* The bridge will ask for confirmation from the Discord server admins to complete the bridge. Once approved, you're all set.
+
+### Unbridging a Room
+
+* In Matrix room give command ``!discord unbridge``
+
 ## Features and Roadmap
 In a vague order of what is coming up next
 
-- 
GitLab