diff --git a/README.md b/README.md index bf31673..7806ac2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # tg2mastodon -tg2mastodon is a Telegram bot to post messages in a Telegram group to Mastodon. +tg2mastodon is a Telegram bot to post messages from a Telegram group to Mastodon. +You should only use on public groups and set the bot to be able to read all the +messages. + +**This is still a Work In Progress, please don't use at the moment, since also +documentation is missing.** + +## TODO + +- [X] Publish text messages from. +- [ ] Handle text > 500 characters (or mastodon instance limit). +- [ ] Message attribution from telegram users (?). +- [ ] Handle messages with 1 photos and caption. +- [ ] Handle messages with multiple photos. +- [ ] Add configuration variable to set mastodon message visibility.