diff --git a/README.md b/README.md index c05860d7a79adfb451ddccb2c3ff2e2296221fc6..f2ce69db5ea096b2675b5e3a8a7c631c1e7f4ca4 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,14 @@ This mod creates a bridge between a [Matrix](https://matrix.org) channel and the in-game chat. The code is shamelessly based on the [irc](https://github.com/minetest-mods/irc) mod and examples from [lua-matrix](https://github.com/aperezdc/lua-matrix). +This branch (`master`) needs a Matrix user that listens for messages and sends to Minetest. Chat messages posted in-game +will be sent with the bot to the Matrix channel like so: + +``` +@minetestbot: <myuser> hello world +``` + +For a bridge where virtual users are created in Matrix, checkout the [appservice](https://github.com/diggers-mt/minetest-matrix/tree/appservice) branch! ## Installing