Skip to content

Commit bb0834a

Browse files
committed
docs: update readme
1 parent 3fad302 commit bb0834a

File tree

1 file changed

+46
-3
lines changed

1 file changed

+46
-3
lines changed

README.md

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@
1616

1717
## 📝 Introduction
1818

19-
Laravel Telegram Git Notifier is a package that allows you to create a Telegram bot to receive notifications from GitHub or GitLab events and manage customization through messages and buttons on Telegram.
19+
Laravel Telegram Git Notifier is a package that allows you to create a Telegram bot to receive notifications from GitHub
20+
or GitLab events and manage customization through messages and buttons on Telegram.
2021

21-
- Send notifications of your GitHub/GitLab repositories to Telegram Bots, Groups, Super Groups (Multiple Topics), and Channels.
22+
- Send notifications of your GitHub/GitLab repositories to Telegram Bots, Groups, Super Groups (Multiple Topics), and
23+
Channels.
2224
- The bot must be created using the [BotFather](https://core.telegram.org/bots#6-botfather)
2325

2426
## 📋 Requirements
@@ -35,11 +37,52 @@ You can install this package via Composer:
3537
composer require cslant/laravel-telegram-git-notifier
3638
```
3739

40+
## 🚀 Usage
41+
42+
See the [Usage - Telegram git notifier Documentation](https://docs.cslant.com/telegram-git-notifier/usage/first_test)
43+
for a list of usage.
44+
3845
Please check and update some configurations in the documentation.
3946

4047
## 📖 Official Documentation
4148

42-
Please see the [Telegram Git Notifier Documentation](https://docs.cslant.com/telegram-git-notifier/) for more information.
49+
Please see the [Telegram Git Notifier Documentation](https://docs.cslant.com/telegram-git-notifier/) for more
50+
information.
51+
52+
## ✨ Supported events
53+
54+
### GitHub Events Available
55+
56+
- [x] Push
57+
- [x] Issues
58+
- [x] Issue Comment
59+
- [x] Pull Request
60+
- [x] Pull Request Review
61+
- [x] Pull Request Review Comment
62+
- [x] Fork
63+
- [x] Commit Comment
64+
- [x] Deployment
65+
- [x] Deployment Status
66+
- [x] Fork
67+
- [x] Gollum
68+
- [x] Watch
69+
70+
... and more events can see in the [all GitHub events available](https://docs.cslant.com/telegram-git-notifier/)
71+
72+
### GitLab Events Available
73+
74+
- [x] Push
75+
- [x] Tag Push
76+
- [x] Issue
77+
- [x] Merge Request
78+
- [x] Note
79+
- [x] Pipeline
80+
- [x] Wiki Page
81+
- [x] Build
82+
- [x] Deployment
83+
- [x] Release
84+
85+
... and more events can see in the [all GitLab events available](https://docs.cslant.com/telegram-git-notifier/)
4386

4487
## License
4588

0 commit comments

Comments
 (0)