From 7fd260cefb4a61cbdfd0d13378a14e341090e9a6 Mon Sep 17 00:00:00 2001 From: mappu Date: Wed, 7 Nov 2018 19:00:25 +1300 Subject: [PATCH] doc: move README to top-level md file --- dist/README.txt => README.md | 47 +++++++++++++++++++----------------- 1 file changed, 25 insertions(+), 22 deletions(-) rename dist/README.txt => README.md (59%) diff --git a/dist/README.txt b/README.md similarity index 59% rename from dist/README.txt rename to README.md index c56f3f6..e0535c4 100644 --- a/dist/README.txt +++ b/README.md @@ -1,10 +1,10 @@ +# nmdc-telegramfrontend + +![](https://img.shields.io/badge/written%20in-Go-blue.svg) + A bot to synchronise chat between an DC hub and a Telegram supergroup. -Tags: NMDC -Written in Go -[go-get]code.ivysaur.me/nmdc-telegramfrontend git https://git.ivysaur.me/code.ivysaur.me/nmdc-telegramfrontend.git[/go-get] - -=FEATURES= +## Features - Supports NMDC / NMDCS / ADC / ADCS hubs - Automatically upload photos/files/videos/audio/stickers to a Contented server for DC users @@ -17,33 +17,36 @@ Written in Go - Option for length requirement on native nick - Disconnect telegram users who fail to log in to the upstream hub -=SETUP= +## 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` + +1. Use BotFather to create a new bot +2. Use BotFather to disable its privacy mode for group chats +3. 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 - - Convert group chat to supergroup - - Grant bot to be an administrator (including ability to add more administrators) - - Settings > "Who can add members" > Only administrators - - Create an invite link - -Handover to nmdc-telegramfrontend - - Run this bot with no -GroupChatID, to learn the groupchat ID - - Post a test message in the group chat, to discover the groupchat ID - - Leave the group chat (long press on mobile, can't do it on desktop) - - Run this bot with -GroupChatID for normal operation -=USAGE= +1. Manually create a group chat and add the bot to it +2. Convert group chat to supergroup +3. Grant bot to be an administrator (including ability to add more administrators) +4. Settings > "Who can add members" > Only administrators +5. Create an invite link + +Handover to `nmdc-telegramfrontend` + +1. Run this bot with no `-GroupChatID`, to learn the groupchat ID +2. Post a test message in the group chat, to discover the groupchat ID +3. Leave the group chat (long press on mobile, can't do it on desktop) +4. Run this bot with `-GroupChatID` for normal operation + +## Usage 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= +## Changelog 2018-06-10 1.0.1 - Send DC captions on TG photos and voice clips