From a034cc1a0c5c882f419c8dd65023339fdbf8bf36 Mon Sep 17 00:00:00 2001 From: rnhmjoj Date: Mon, 27 Feb 2017 00:18:51 +0100 Subject: [PATCH] add README --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5f9f1a4 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# hubot-matrix +## matrix.org adapter for Hubot + +This is a [Hubot](http://hubot.github.com/) adapter for the [Matrix](https://matrix.org) protocol. + +### Supported features +- Sending/receiving text messages +- Sending image messages +- Automatically joining room + +### Config parameters + +| Variable | Default value | Description | +|---------------------------|--------------------|-------------------------------------------| +| HUBOT_MATRIX_DATA | ./matrix-data | location where the session will be stored | +| HUBOT_MATRIX_HOST_SERVER | https://matrix.org | homeserver URL | +| HUBOT_MATRIX_USER | `robot.name` | account username | +| HUBOT_MATRIX_PASSWORD | N/A | account password | + +### License +Copyright 2017 David A Roberts + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.