Update documentation for version 2.0

This commit is contained in:
Jeremy Baxter 2023-01-01 12:03:47 +13:00
parent 959c3c9c9b
commit 107ec868ba
9 changed files with 204 additions and 181 deletions

31
config.lua Normal file
View file

@ -0,0 +1,31 @@
login = {
-- The Matrix server to use.
server = "matrix-client.matrix.org", -- matrix.org
-- The user to log in to.
username = "user",
-- The password for the user.
password = "password",
-- The access token to use (instead of credentials).
-- If token equals nil, credentials are used.
-- If token is not nil, credentials are ignored.
token = nil
-- The server value needs to be provided.
-- You can choose to login with user credentials or a
-- token. One of them needs to be provided.
}
rooms = {
-- Room aliases.
-- Here you can add aliases for rooms,
-- instead of having to type the confusing
-- Room ID every single time you send a message.
-- Examples:
--my_alias = "!AbCdEfGhIjKl:burger.land",
--lounge = "!MnOpQrSTuVWxYz:gaming.bruvs"
-- When you want to send to a Matrix room, you
-- can just type the alias instead of the long Room ID.
}