From 2e4b7fac1146c186f28599d62379d7e9912fda81 Mon Sep 17 00:00:00 2001
From: Wim <wim@42.be>
Date: Sun, 20 Nov 2016 17:01:53 +0100
Subject: [PATCH] Update documentation and sample (telegram)

---
 README.md                |  5 +++--
 matterbridge.toml.sample | 31 +++++++++++++++++++++++++++++++
 2 files changed, 34 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 80b6a679..28ecdc8a 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # matterbridge
-Simple bridge between mattermost, IRC, XMPP, Gitter, Slack and Discord
+Simple bridge between mattermost, IRC, XMPP, Gitter, Slack, Discord and Telegram.
 
-* Relays public channel messages between multiple mattermost, IRC, XMPP, Gitter, Slack and Discord. Pick and mix.
+* Relays public channel messages between multiple mattermost, IRC, XMPP, Gitter, Slack, Discord and Telegram. Pick and mix.
 * Supports multiple channels.
 * Matterbridge can also work with private groups on your mattermost.
 * Allow for bridging the same bridges, which means you can eg bridge between multiple mattermosts.
@@ -21,6 +21,7 @@ Accounts to one of the supported bridges
 * [Gitter] (https://gitter.im)
 * [Slack] (https://slack.com)
 * [Discord] (https://discordapp.com)
+* [Telegram] (https://telegram.org)
 
 ## Docker
 Create your matterbridge.toml file locally eg in ```/tmp/matterbridge.toml```
diff --git a/matterbridge.toml.sample b/matterbridge.toml.sample
index 831e99f2..2e5f8186 100644
--- a/matterbridge.toml.sample
+++ b/matterbridge.toml.sample
@@ -342,6 +342,36 @@ RemoteNickFormat="[{PROTOCOL}] <{NICK}> "
 #OPTIONAL (default false)
 ShowJoinPart=false
 
+###################################################################
+#telegram section
+###################################################################
+[telegram]
+
+#You can configure multiple servers "[telegram.name]" or "[telegram.name2]"
+#In this example we use [telegram.secure]
+#REQUIRED
+[telegram.secure]
+#Token to connect with telegram API
+#REQUIRED
+Token="Yourtokenhere"
+
+#Nicks you want to ignore. 
+#Messages from those users will not be sent to other bridges.
+#OPTIONAL
+IgnoreNicks="spammer1 spammer2"
+
+#RemoteNickFormat defines how remote users appear on this bridge 
+#The string "{NICK}" (case sensitive) will be replaced by the actual nick / username.
+#The string "{BRIDGE}" (case sensitive) will be replaced by the sending bridge
+#The string "{PROTOCOL}" (case sensitive) will be replaced by the protocol used by the bridge
+#OPTIONAL (default empty)
+RemoteNickFormat="[{PROTOCOL}] <{NICK}> "
+
+#Enable to show users joins/parts from other bridges (only from irc-bridge at the moment)
+#OPTIONAL (default false)
+ShowJoinPart=false
+
+
 ###################################################################
 #Gateway configuration
 ###################################################################
@@ -381,6 +411,7 @@ enable=true
     #discord    - channel (without the #)
     #           - ID:123456789 (where 123456789 is the channel ID) 
     #               (https://github.com/42wim/matterbridge/issues/57)
+    #telegram   - chatid (a large negative number, eg -123456789)
     #REQUIRED
     channel="#testing"