spacenerdmo/pnut-matrix
1
0
Fork 0
Code Issues 5 Pull requests Projects Releases 5 Packages 1 Wiki Activity

cleanup of readme file

Browse source
This commit is contained in:
Morgan McMillian 2020-03-26 13:29:01 -07:00
parent d4c4cde685
commit 6b4b75c891
1 changed files with 3 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -7,24 +7,12 @@ This bridge will pass pnut.io channel messages through to Matrix, and Matrix mes
## Usage
To join a channel on pnut.io configured for public use:
* `/join #pnut_ID:monkeystew.net` where ID is the id number of the channel on pnut.io
* You can get the id number by looking at the URL when viewing the channel in patter.chat
By default any messages you send will be posted as the matrixbot user on pnut.io with your display name. You can however authorize pnut-matrix to post as your account instead.
To link your Matrix ID with your pnut.io account:
* Start a direct chat with `@pnut-matrix-bot:monkeystew.net`
* Type the `!help` command to get started.
Visit the project [wiki](https://gitlab.dreamfall.space/thrrgilag/pnut-matrix/-/wikis/home) for up to date information on using the bridge hosted on dreamfall.space.
## Questions, comments, or issues
Join the chat!
* [Matrix] [#pnut-matrix:monkeystew.net](https://matrix.to/#/#pnut-matrix:monkeystew.net)
* [pnut.io] [patter.chat](https://patter.chat/room/999)
* [XMPP] [pnut-matrix@chat.monkeystew.net](xmpp:pnut-matrix@chat.monkeystew.net?join)
* [#pnut-matrix:dreamfall.space](https://matrix.to/#/#pnut-matrix:dreamfall.space)
* [pnut.io](https://patter.chat/room/999)