rani/matterbridge.git

commit a107d62143cc822978024250f907388ca9d4180b Author: Patrick Connolly <patrick.c.connolly@gmail.com> Date: Sat Nov 10 04:19:36 2018 +0000 Improve README formatting (incl codeclimate badges) (#578) * Updated header, removed whitespace, added codeclimate badges, adjusted titles. * TOML formatting in README. diff --git a/README.md b/README.md index 1bcbf97..55ed0a6 100644 --- a/README.md +++ b/README.md @@ -120 +138 @@ -# matterbridge -Click on one of the badges below to join the chat - -[](https://gitter.im/42wim/matterbridge) [](https://webchat.freenode.net/?channels=matterbridgechat) [](https://discord.gg/AkKPtrQ) [](https://riot.im/app/#/room/#matterbridge:matrix.org) [](https://join.slack.com/matterbridgechat/shared_invite/MjEwODMxNjU1NDMwLTE0OTk2MTU3NTMtMzZkZmRiNDZhOA) [](https://framateam.org/signup_user_complete/?id=tfqm33ggop8x3qgu4boeieta6e) [](https://inverse.chat) [](https://www.twitch.tv/matterbridge) [](https://matterbridge.zulipchat.com/register/) - -[](https://github.com/42wim/matterbridge/releases/latest) [](https://bintray.com/42wim/nightly/Matterbridge/_latestVersion) - - - -Simple bridge between IRC, XMPP, Gitter, Mattermost, Slack, Discord, Telegram, Rocket.Chat, Hipchat(via xmpp), Matrix, Steam, ssh-chat and Zulip -Has a REST API. -Minecraft server chat support via [MatterLink](https://github.com/elytra/MatterLink) +<div align="center">   -**Mattermost isn't required to run matterbridge. It bridges between any supported protocol.** -(The name matterbridge is a remnant when it was only bridging mattermost) +# matterbridge   -# Table of Contents +<br /> + **A simple chat bridge**<br /> + Letting people be where they want to be.<br /> + _{Bridges between a growing number of protocols.} + + ^{+ + [Gitter][mb-gitter] | + [IRC][mb-irc] | + [Discord][mb-discord] | + [Matrix][mb-matrix] | + [Slack][mb-slack] | + [Mattermost][mb-mattermost] | + [XMPP][mb-xmpp] | + [Twitch][mb-twitch] | + [Zulip][mb-zulip] | + And more... +} + +---- +[](https://github.com/42wim/matterbridge/releases/latest) + [](https://bintray.com/42wim/nightly/Matterbridge/_latestVersion) + [](https://codeclimate.com/github/42wim/matterbridge/maintainability) + [](https://codeclimate.com/github/42wim/matterbridge/test_coverage)<br /> + <hr /> +</div> +<div align="right">^{+ +**Note:** Matter<em>most</em> isn't required to run matter<em>bridge</em>.}</div> + +### Table of Contents   * [Features](https://github.com/42wim/matterbridge/wiki/Features) * [API](#API)   * [Requirements](#requirements) @@ -247 +427 @@ Minecraft server chat support via [MatterLink](https://github.com/elytra/MatterL * [Building](#building)   * [Configuration](#configuration) * [Howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) - * [Examples](#examples) + * [Examples](#examples)   * [Running](#running) * [Docker](#docker)   * [Changelog](#changelog) @@ -337 +517 @@ Minecraft server chat support via [MatterLink](https://github.com/elytra/MatterL   * [Articles](#articles)   * [Thanks](#thanks)   -# Features +## Features  * [Support bridging between any protocols](https://github.com/42wim/matterbridge/wiki/Features#support-bridging-between-any-protocols)  * [Support multiple gateways(bridges) for your protocols](https://github.com/42wim/matterbridge/wiki/Features#support-multiple-gatewaysbridges-for-your-protocols)  * [Message edits and deletes](https://github.com/42wim/matterbridge/wiki/Features#message-edits-and-deletes) @@ -437 +617 @@ Minecraft server chat support via [MatterLink](https://github.com/elytra/MatterL  * [Private groups](https://github.com/42wim/matterbridge/wiki/Features#private-groups)  * [API](https://github.com/42wim/matterbridge/wiki/Features#api)   -## API +### API  The API is very basic at the moment and rather undocumented.    Used by at least 3 projects. Feel free to make a PR to add your project to this list. @@ -527 +707 @@ Used by at least 3 projects. Feel free to make a PR to add your project to this  * [pyCord](https://github.com/NikkyAI/pyCord) (crossplatform chatbot)  * [Mattereddit](https://github.com/bonehurtingjuice/mattereddit) (Reddit chat support)   -# Requirements +## Requirements  Accounts to one of the supported bridges  * [Mattermost](https://github.com/mattermost/platform/) 3.8.x - 3.10.x, 4.x, 5.x  * [IRC](http://www.mirc.com/servers.html) @@ -6918 +8718 @@ Accounts to one of the supported bridges  * [Ssh-chat](https://github.com/shazow/ssh-chat)  * [Zulip](https://zulipchat.com)   -# Screenshots +## Screenshots  See https://github.com/42wim/matterbridge/wiki   -# Installing -## Binaries +## Installing +### Binaries  * Latest stable release [v1.11.3](https://github.com/42wim/matterbridge/releases/latest) -* Development releases (follows master) can be downloaded [here](https://dl.bintray.com/42wim/nightly/) +* Development releases (follows master) can be downloaded [here](https://dl.bintray.com/42wim/nightly/)   -## Building +### Building  Go 1.8+ is required. Make sure you have [Go](https://golang.org/doc/install) properly installed, including setting up your [GOPATH](https://golang.org/doc/code.html#GOPATH).   -After Go is setup, download matterbridge to your $GOPATH directory. +After Go is setup, download matterbridge to your $GOPATH directory.    ```  cd $GOPATH @@ -9416 +11216 @@ $ ls bin/  matterbridge  ```   -# Configuration -## Basic configuration +## Configuration +### Basic configuration  See [howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) for a step by step walkthrough for creating your configuration.   -## Advanced configuration +### Advanced configuration  * [matterbridge.toml.sample](https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.sample) for documentation and an example.   -## Examples -### Bridge mattermost (off-topic) - irc (#testing) -``` +### Examples +#### Bridge mattermost (off-topic) - irc (#testing) +```toml  [irc] [irc.freenode] Server="irc.freenode.net:6667" @@ -1308 +1488 @@ enable=true channel="off-topic"  ```   -### Bridge slack (#general) - discord (general) -``` +#### Bridge slack (#general) - discord (general) +```toml  [slack]  [slack.test]  Token="yourslacktoken" @@ -1587 +1767 @@ RemoteNickFormat="[{PROTOCOL}/{BRIDGE}] <{NICK}> " channel = "general"  ```   -# Running +## Running    See [howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) for a step by step walkthrough for creating your configuration.   @@ -17424 +19224 @@ Usage of ./matterbridge: show version  ```   -## Docker -Create your matterbridge.toml file locally eg in ```/tmp/matterbridge.toml``` +### Docker +Create your matterbridge.toml file locally eg in `/tmp/matterbridge.toml`  ```  docker run -ti -v /tmp/matterbridge.toml:/matterbridge.toml 42wim/matterbridge  ```   -# Changelog +## Changelog  See [changelog.md](https://github.com/42wim/matterbridge/blob/master/changelog.md)   -# FAQ +## FAQ    See [FAQ](https://github.com/42wim/matterbridge/wiki/FAQ)   -Want to tip ? +Want to tip ?  * eth: 0xb3f9b5387c66ad6be892bcb7bbc67862f3abc16f  * btc: 1N7cKHj5SfqBHBzDJ6kad4BzeqUBBS2zhs   -# Related projects +## Related projects  * [matterbridge-heroku](https://github.com/cadecairos/matterbridge-heroku)  * [matterbridge config viewer](https://github.com/patcon/matterbridge-heroku-viewer)  * [matterbridge autoconfig](https://github.com/patcon/matterbridge-autoconfig) @@ -1997 +2177 @@ Want to tip ?  * [mattereddit](https://github.com/bonehurtingjuice/mattereddit)  * [pyCord](https://github.com/NikkyAI/pyCord) (crossplatform chatbot)   -# Articles +## Articles  * https://mattermost.com/blog/connect-irc-to-mattermost/  * https://blog.valvin.fr/2016/09/17/mattermost-et-un-channel-irc-cest-possible/  * https://blog.brightscout.com/top-10-mattermost-integrations/ @@ -2087 +2267 @@ Want to tip ?  * https://kopano.com/blog/matterbridge-bridging-mattermost-chat/  * https://www.stitcher.com/s/?eid=52382713   -# Thanks +## Thanks  [](https://www.digitalocean.com/) for sponsoring demo/testing droplets.    Matterbridge wouldn't exist without these libraries: @@ -2253 +24315 @@ Matterbridge wouldn't exist without these libraries:  * telegram - https://github.com/go-telegram-bot-api/telegram-bot-api  * xmpp - https://github.com/mattn/go-xmpp  * zulip - https://github.com/ifo/gozulipbot + +<!-- Links --> + + [mb-gitter]: https://gitter.im/42wim/matterbridge + [mb-irc]: https://webchat.freenode.net/?channels=matterbridgechat + [mb-discord]: https://discord.gg/AkKPtrQ + [mb-matrix]: https://riot.im/app/#/room/#matterbridge:matrix.org + [mb-slack]: https://join.slack.com/matterbridgechat/shared_invite/MjEwODMxNjU1NDMwLTE0OTk2MTU3NTMtMzZkZmRiNDZhOA + [mb-mattermost]: https://framateam.org/signup_user_complete/?id=tfqm33ggop8x3qgu4boeieta6e + [mb-xmpp]: https://inverse.chat/ + [mb-twitch]: https://www.twitch.tv/matterbridge + [mb-zulip]: https://matterbridge.zulipchat.com/register/ diff --git a/img/matterbridge-notext.gif b/img/matterbridge-notext.gif new file mode 100644 index 0000000..009b05c Binary files /dev/null and b/img/matterbridge-notext.gif differ