From f37c6b1ca8c65df5d83cc785f2007c7abcd862eb Mon Sep 17 00:00:00 2001 From: Plague Doctor Date: Thu, 9 Jan 2020 00:41:34 +0000 Subject: [PATCH] Add README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3da2249 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ + Matrix bot nodes for Node-RED + ==== + +This package contains nodes to send and receive messages as a Matrix node. + +## Quick usage guide + +This package adds 3 node types to Node-RED palette (Matrix section, at the bottom): +* *Matrix sender*: sends messages from your Node-RED flow to the chatroom +* *Matrix receiver*: listens to messages in a chatroom and sends them to your Node-RED flow +* *Matrix command*: listens only to messages starting with a specific command and sends them to your Node-RED flow + +All of these nodes require a Matrix Configuration with the following settings: +* *User ID*: the user ID in the matrix server, for instance @mybot:matrix.org +* *Access token*: the access token of the user in the matrix server +* *Server URL*: URL of the Matrix homeserver, e.g. https://matrix.org +* *Room ID*: ID of the chatroom to join when starting. If no room is specified, it will automatically join any room where it is invited