From f7bd8adbb880bf989838d0db7d823f8750a14a20 Mon Sep 17 00:00:00 2001 From: Will Hunt <will@half-shot.uk> Date: Sun, 21 Jan 2018 17:10:12 +0000 Subject: [PATCH] Add some useful documentation on how to join a room --- README.md | 7 +------ docs/howto.md | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+), 6 deletions(-) create mode 100644 docs/howto.md diff --git a/README.md b/README.md index ca1d956..1da958f 100644 --- a/README.md +++ b/README.md @@ -71,12 +71,7 @@ and synapse. Any new servers/guilds you bridge should show up in the network lis * For the bot to appear online on Discord you need to run the bridge itself. * ``node ./build/src/discordas.js -p 9005 -c config.yaml`` -## Setting privileges on bridge managed rooms - -* The ``adminme`` script is provided to set Admin/Moderator or any other custom power level to a specific user. -* e.g. To set Alice to Admin on her ``example.com`` HS on default config. (``config.yaml``) - * ``npm run adminme -- -r '!AbcdefghijklmnopqR:example.com' -u '@Alice:example.com' -p '100'`` - * Run ``npm run adminme -- -h`` for usage. +[Howto](./docs/howto.md) ## Features and Roadmap In a vague order of what is coming up next diff --git a/docs/howto.md b/docs/howto.md new file mode 100644 index 0000000..bedbd66 --- /dev/null +++ b/docs/howto.md @@ -0,0 +1,19 @@ + +### Join a room + +The default format for room aliases (which are automatically resolved, whether the room exists on Matrix or not) is: + +``#_discord_guildid_channelid`` + +You can find these on discord in the browser where: + +``https://discordapp.com/channels/282616294245662720/282616372591329281`` + +is formatted as https://discordapp.com/channels/``guildid``/``channelid`` + +### Set privileges on bridge managed rooms + +* The ``adminme`` script is provided to set Admin/Moderator or any other custom power level to a specific user. +* e.g. To set Alice to Admin on her ``example.com`` HS on default config. (``config.yaml``) + * ``npm run adminme -- -r '!AbcdefghijklmnopqR:example.com' -u '@Alice:example.com' -p '100'`` + * Run ``npm run adminme -- -h`` for usage. -- GitLab