5
0
mirror of https://github.com/cwinfo/matterbridge.git synced 2024-09-19 15:49:36 +00:00

Update readme about REST api projects (matterlink,pycord)

This commit is contained in:
Wim 2018-01-28 19:47:48 +01:00
parent a7a4554a85
commit e1a4d7f77e

View File

@ -8,7 +8,8 @@ Click on one of the badges below to join the chat
![matterbridge.gif](https://s15.postimg.org/qpjhp6y3f/matterbridge.gif) ![matterbridge.gif](https://s15.postimg.org/qpjhp6y3f/matterbridge.gif)
Simple bridge between Mattermost, IRC, XMPP, Gitter, Slack, Discord, Telegram, Rocket.Chat, Hipchat(via xmpp), Matrix and Steam. Simple bridge between Mattermost, IRC, XMPP, Gitter, Slack, Discord, Telegram, Rocket.Chat, Hipchat(via xmpp), Matrix and Steam.
Has a REST API. Has a REST API.
Minecraft server chat support via [MatterLink](https://github.com/elytra/MatterLink)
# Table of Contents # Table of Contents
* [Features](#features) * [Features](#features)
@ -35,6 +36,14 @@ Has a REST API.
* Edits and delete messages across bridges that support it (mattermost,slack,discord,gitter,telegram) * Edits and delete messages across bridges that support it (mattermost,slack,discord,gitter,telegram)
* REST API to read/post messages to bridges (WIP). * REST API to read/post messages to bridges (WIP).
## API
The API is very basic at the moment and rather undocumented.
Used by at least 2 projects. Feel free to make a PR to add your project to this list.
* [MatterLink](https://github.com/elytra/MatterLink) (Matterbridge link for Minecraft Server chat)
* [pyCord](https://github.com/NikkyAI/pyCord) (crossplatform chatbot)
# Requirements # Requirements
Accounts to one of the supported bridges Accounts to one of the supported bridges
* [Mattermost](https://github.com/mattermost/platform/) 3.8.x - 3.10.x, 4.x * [Mattermost](https://github.com/mattermost/platform/) 3.8.x - 3.10.x, 4.x