basic readme

This commit is contained in:
Robin Appelman 2020-05-05 18:45:32 +02:00
commit 3c6231e015

18
README.md Normal file
View file

@ -0,0 +1,18 @@
# mx-puppet-steam
Matrix <-> Steam puppeting bridge based on [mx-puppet-bridge](https://github.com/Sorunome/mx-puppet-bridge)
## Status
The bridge is in early status, logging in and 1<->1 messages are mostly working.
Group messages are not working, typing status works somewhat.
## Linking
Start a chat with @_steampuppet_bot:yourserver.com
```
link <username> <password>
```
If a steam guard (mobile or email) code is required you will be asked for the code.