The MIT License

Copyright (c) 2018 Jasmin Bom

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.

(temporary name)

Telegram Bot that notifies you about events your public GitHub repositories.

I am an improved version of the Telegram GitHub Bot. See below for more details.

[Tab here](https://t.me/githubrevisedbot) to go to telegram and talk to me.

*Features marked with a star \* are improvement over the telegram GitHub Bot.*

- Provides notifications for the following events

- New issues

- Comments on issues

- New pull requests

- Comments on pull requests

- New pull request reviews *

- Pull request review comments *

- Comment on a commit/diff *

- Wiki page updated *

- Commits pushed

- Either to any branch or only master *

- Reply to issues, PRs, or comments in Telegram to easily post a comment on github

- Fancy (and hopefully intuitive) settings interface using InlineKeyboardButtons + switch_inline_current_chat *

- Uses GitHub Apps instead of complicated manual webhooks *

- An actual privacy policy (/privacy) *

- Notification message length is truncated to configurable account of character to reduce visual spam *

- Uses GitHub API to render markdown meaning the notification text should more closely resemble the actual text on github *

The two last ones mean that where the Telegram GitHub Bot simply stays silent (weird html/markdown or more than 4000 characters), this improved version handles with grace!

To use the bot you do not need to clone the source code or anything, simply [tab here](https://t.me/githubrevisedbot) to get started. The guide below is only if you would like to host the bot yourself.

TODO: Guide

TODO: Contributing guide

TLDR: Contributions (either issues or PRs) are very welcome!

The source code of this Telegram Bot is provided under the (MIT license)[./LICENSE].