Skip to content

Commit f39fa7f

Browse files
committed
Add readme and license
1 parent 2f878a6 commit f39fa7f

File tree

2 files changed

+68
-0
lines changed

2 files changed

+68
-0
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License
2+
3+
Copyright (c) 2018 Jasmin Bom
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# GitHubBot Revised
2+
(temporary name)
3+
4+
Telegram Bot that notifies you about events your public GitHub repositories.
5+
6+
I am an improved version of the Telegram GitHub Bot. See below for more details.
7+
8+
[Tab here](https://t.me/githubrevisedbot) to go to telegram and talk to me.
9+
10+
## Features
11+
*Features marked with a star \* are improvement over the telegram GitHub Bot.*
12+
13+
- Provides notifications for the following events
14+
- New issues
15+
- Comments on issues
16+
- New pull requests
17+
- Comments on pull requests
18+
- New pull request reviews *
19+
- Pull request review comments *
20+
- Comment on a commit/diff *
21+
- Wiki page updated *
22+
- Commits pushed
23+
- Either to any branch or only master *
24+
- Reply to issues, PRs, or comments in Telegram to easily post a comment on github
25+
- Fancy (and hopefully intuitive) settings interface using InlineKeyboardButtons + switch_inline_current_chat *
26+
- Uses GitHub Apps instead of complicated manual webhooks *
27+
- An actual privacy policy (/privacy) *
28+
- Notification message length is truncated to configurable account of character to reduce visual spam *
29+
- Uses GitHub API to render markdown meaning the notification text should more closely resemble the actual text on github *
30+
31+
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!
32+
33+
## Running
34+
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.
35+
36+
TODO: Guide
37+
38+
## Contributing
39+
40+
TODO: Contributing guide
41+
TLDR: Contributions (either issues or PRs) are very welcome!
42+
43+
## License
44+
45+
The source code of this Telegram Bot is provided under the (MIT license)[./LICENSE].
46+
47+

0 commit comments

Comments
 (0)