rnhmjoj/hubot-matrix
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add README

Browse Source
This commit is contained in:
rnhmjoj 2017-02-27 00:18:51 +01:00
parent e2199c289e
commit a034cc1a0c
No known key found for this signature in database
GPG Key ID: 362BB82B7E496B7C
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md Normal file
View File

@ -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.