diff --git a/README.txt b/README.txt index aebd956..a7993a1 100644 --- a/README.txt +++ b/README.txt @@ -1,24 +1,27 @@ -A bot to synchronise chat between an NMDC/ADC hub and a Telegram supergroup. +A bot to synchronise chat between an DC hub and a Telegram supergroup. Tags: NMDC Written in Go ## FEATURES -- NMDC/ADC support -- Exclude messages from multiple hub nicks (e.g. hub-security, any helper bots that are unnecessary given telegram's features) +- Supports NMDC / NMDCS / ADC / ADCS hubs +- Automatically upload photos/files/videos/audio/stickers to a Contented server for DC users +- Fallback upload to thumbnail-only if exceeding declared Contented file size limit +- Convert telegram quoted messages to DC quoting style +- Exclude messages from multiple hub nicks (e.g. `Hub-Security` / `PtokaX` and helper bots) - Standalone binary +- PM with native users +- Get native userlist inside the telegram group chat +- Option for length requirement on native nick +- Disconnect telegram users who fail to log in to the upstream hub ## SETUP Create a new telegram bot - Use BotFather to create a new bot - Use BotFather to disable its privacy mode for group chats - - Use BotFather to add commands (that appear in the groupchat). Recommendation: - -` -userlist - List native online users -` + - Use BotFather to add commands (that appear in the groupchat). Recommendation: `userlist - List native online users` Create a telegram group - Manually create a group chat and add the bot to it @@ -38,3 +41,8 @@ Handover to nmdc-telegramfrontend Chat with the bot to enter/leave the synchronised channel. Sometimes the telegram invite links can take a few minutes to activate, especially if there has been unusual activity (e.g. frequent join/parts) + +## CHANGELOG + +2018-06-03 +- Private beta