88
99## Information
1010
11- - Send GitHub notifications of your repositories to Telegram Bot , Groups, Channels.
11+ - Send GitHub notifications of your repositories to Telegram Bots , Groups, and Channels.
1212- The bot must be created using the [ BotFather] ( https://core.telegram.org/bots#6-botfather )
1313
1414## Requirement
2020
2121## Installation
2222
23- The first , please clone and install this project via [ Composer] ( https://getcomposer.org/ ) :
23+ First , please clone and install this project via [ Composer] ( https://getcomposer.org/ ) :
2424
2525``` bash
2626composer create-project lbiltech/telegram-bot-github-notify
@@ -36,7 +36,7 @@ To create a new bot, you need to talk to [BotFather](https://core.telegram.org/b
36361 . Open a chat with [ BotFather] ( https://telegram.me/botfather ) and send ` /newbot ` command.
37372 . Enter a friendly name for your bot. This name will be displayed in contact details and elsewhere.
38383 . Enter a unique username for your bot. It must end in ` bot ` . Like this, for example: ` TetrisBot ` or ` tetris_bot ` .
39- 4 . Copy the HTTP API access token provided by [ BotFather] ( https://telegram.me/botfather ) and paste it in your ` .env ` file.
39+ 4 . Copy the HTTP API access token provided by [ BotFather] ( https://telegram.me/botfather ) and paste it into your ` .env ` file.
4040
4141``` shell
4242TELEGRAM_BOT_TOKEN=123456789:ABCDEFGHIJKLMNOPQRSTUVWXYZ
@@ -56,23 +56,23 @@ TELEGRAM_BOT_CHAT_ID=123456789
5656
5757### Set the webhook
5858
59- #### Set the webhook from source code
59+ #### Set the webhook from the source code
6060
61- After setting up your domain and SSL certificate, you need to set the webhook for your bot. Go to:
61+ After setting up your domain and SSL certificate, you need to set up the webhook for your bot. Go to:
6262
6363``` http request
6464<APP_URL>/setWebhook.php
6565```
6666
67- If you see the following message, it means that the webhook has been set successfully.
67+ If you see the following message, it means that the webhook has been sent successfully.
6868
6969``` json
7070{"ok" :true ,"result" :true ,"description" :" Webhook was set" }
7171```
7272
7373#### Set the webhook manually
7474
75- If you want to set the webhook manually, you can use the following url :
75+ If you want to set the webhook manually, you can use the following URL :
7676
7777``` http request
7878https://api.telegram.org/bot<YourBOTToken>/setWebhook?url=<APP_URL>
@@ -89,7 +89,7 @@ Now your configuration is complete. And it will be like this:
8989``` shell
9090APP_NAME=' Telegram Github Notify Bot'
9191
92- # Set your app url here
92+ # Set your app URL here
9393APP_URL=https://tele-noti-git.com
9494
9595TELEGRAM_BOT_TOKEN=6162840106:AAH3g20lMQIkG_wHHu8R_ngdtG541uzoq4
@@ -112,12 +112,12 @@ Now you can send a message to your bot, and you will receive a notification.
112112## Set webhook on your GitHub repository
113113
1141141 . Go to your repository settings
115- 2 . Go to ` Webhooks ` section
115+ 2 . Go to the ` Webhooks ` section
1161163 . Click on ` Add webhook `
1171174 . Set ` Payload URL ` to ` <APP_URL> `
1181185 . Set ` Content type ` to ` application/x-www-form-urlencoded `
1191196 . Which events would you like to trigger this webhook? Select ` Let me select individual events. `
120- 7 . Click on ` Active ` checkbox and Add webhook button.
120+ 7 . Click on the ` Active ` checkbox and Add webhook button.
1211218 . Done. You will receive a notification when your repository has a new event.
122122
123123Here is the first notification you will receive: ♻️ ** Connection Successful**
0 commit comments