From 7428d655e5111d66c34fe60db018074c8c94051f Mon Sep 17 00:00:00 2001 From: Morgan McMillian Date: Fri, 27 May 2022 01:41:02 +0000 Subject: [PATCH] Create Usage --- Usage.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 Usage.md diff --git a/Usage.md b/Usage.md new file mode 100644 index 0000000..3f8d1cd --- /dev/null +++ b/Usage.md @@ -0,0 +1,22 @@ +# Using the public bridge + +A public matrix bridge for pnut.io is alive once again currently at pnut-matrix.dreamfall.space, although it may be a bit unstable. + +## Authorizing your Matrix ID to your pnut.io account + +By default messages from unknown Matrix users are limited to public channels on pnut.io and will be relayed by [@matrixbot](https://beta.pnut.io/@matrixbot) with the Matrix ID embedded in the message. To authorize your account start a direct chat with [@pnut:pnut-matrix.dreamfall.space](https://matrix.to/#/@pnut:pnut-matrix.dreamfall.space) and type `help` to see the list of available commands. + +## Joining a channel + +To join a channel on pnut.io from Matrix you'll need to know the channel ID number. If you are using a web client such as Beta or patter.chat you can find the ID number in the URL. Channel names start with the prefix `#pnut_` followed by the channel ID number and bridge homeserver. + +So to join pnut-matrix (https://beta.pnut.io/channels/999) use: + +`#pnut_999:pnut-matrix.dreamfall.space` + +## Private Messages + +To send a private message to another user at pnut.io your Matrix ID must be authorized to your pnut.io account. To start a private conversation use the prefix `@pnut_` followed by their username and bridge homeserver. + +`@pnut_thrrgilag:pnut-matrix.dreamfall.space` +