doc: format README for code.ivysaur.me

This commit is contained in:
mappu 2018-06-09 18:45:04 +12:00
parent 3dc931aa36
commit dd6d1c73bb

10
dist/README.txt vendored
View File

@ -3,7 +3,7 @@ A bot to synchronise chat between an DC hub and a Telegram supergroup.
Tags: NMDC
Written in Go
## FEATURES
=FEATURES=
- Supports NMDC / NMDCS / ADC / ADCS hubs
- Automatically upload photos/files/videos/audio/stickers to a Contented server for DC users
@ -16,7 +16,7 @@ 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
@ -36,15 +36,15 @@ Handover to nmdc-telegramfrontend
- Leave the group chat (long press on mobile, can't do it on desktop)
- Run this bot with -GroupChatID for normal operation
## USAGE
=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-09 v1.0.0
2018-06-09 1.0.0
- Initial public release
2018-06-03