update readme & installing

Author: tanhongit

README.md

@@ -16,13 +16,110 @@
 - PHP ^8.0
 - Composer
 - Telegram Bot
+- SSL Certificate
 
 ## Installation
 
-You can clone and install this project via [Composer](https://getcomposer.org/):
+The first, please clone and install this project via [Composer](https://getcomposer.org/):
 
 ```bash
 composer create-project lbiltech/telegram-bot-github-notify
 ```
 
-...
+After running the command above, you will have the project installed under `telegram-bot-github-notify` directory,
+and the environment file `.env` will be created automatically.
+
+### Create a New Bot
+
+To create a new bot, you need to talk to [BotFather](https://core.telegram.org/bots#6-botfather) and follow a few simple steps.
+
+1. Open a chat with [BotFather](https://telegram.me/botfather) and send `/newbot` command.
+2. Enter a friendly name for your bot. This name will be displayed in contact details and elsewhere.
+3. Enter a unique username for your bot. It must end in `bot`. Like this, for example: `TetrisBot` or `tetris_bot`.
+4. Copy the HTTP API access token provided by [BotFather](https://telegram.me/botfather) and paste it in your `.env` file.
+
+```shell
+TELEGRAM_BOT_TOKEN=123456789:ABCDEFGHIJKLMNOPQRSTUVWXYZ
+```
+
+### Get your Chat ID and add it to the .env file
+
+1. Open a chat with your bot.
+2. Send a message to your bot.
+3. Go to the following URL: `https://api.telegram.org/bot<YourBOTToken>/getUpdates`
+4. Look for the `"chat":{"id":` field and copy the number after it. This is your Chat ID.
+5. Paste the Chat ID in your `.env` file.
+
+```shell
+TELEGRAM_BOT_CHAT_ID=123456789
+```
+
+### Set the webhook
+
+#### Set the webhook from source code
+
+After setting up your domain and SSL certificate, you need to set the webhook for your bot. Go to:
+
+```http request
+<APP_URL>/setWebhook.php
+```
+
+If you see the following message, it means that the webhook has been set successfully.
+
+```json
+{"ok":true,"result":true,"description":"Webhook was set"}
+```
+
+#### Set the webhook manually
+
+If you want to set the webhook manually, you can use the following url:
+
+```http request
+https://api.telegram.org/bot<YourBOTToken>/setWebhook?url=<APP_URL>
+```
+
+### Add chat ids you want to receive notifications to the .env file
+
+```shell
+TELEGRAM_NOTIFY_CHAT_IDS="123456789,987654321,-123456789"
+```
+
+Now your configuration is complete. And it will be like this:
+
+```shell
+APP_NAME='Telegram Github Notify Bot'
+
+# Set your app url here
+APP_URL=https://tele-noti-git.com
+
+TELEGRAM_BOT_TOKEN=6162840106:AAH3g20lMQIkG_wHHu8R_ngdtG541uzoq4
+TELEGRAM_BOT_CHAT_ID=6872320129
+
+# Set your telegram group chat ids here ( please use comma to separate )
+TELEGRAM_NOTIFY_CHAT_IDS="-978339113,-1001933979183"
+
+TIMEZONE=Asia/Ho_Chi_Minh
+```
+
+## Usage
+
+Now you can send a message to your bot, and you will receive a notification.
+
+```text
+/start
+```
+
+## Set webhook on your GitHub repository
+
+1. Go to your repository settings
+2. Go to `Webhooks` section
+3. Click on `Add webhook`
+4. Set `Payload URL` to `<APP_URL>`
+5. Set `Content type` to `application/x-www-form-urlencoded`
+6. Which events would you like to trigger this webhook? Select `Let me select individual events.`
+7. Click on `Active` checkbox and Add webhook button.
+8. Done. You will receive a notification when your repository has a new event.
+
+Here is the first notification you will receive: ♻️ **Connection Successful**
+
+> **You can add multiple webhooks to your repository.**

composer.json

@@ -45,5 +45,13 @@
   "config": {
     "sort-packages": true,
     "optimize-autoloader": true
+  },
+  "scripts": {
+    "post-install-cmd": [
+      "php -r \"file_exists('.env') || copy('.env.example', '.env');\""
+    ],
+    "post-update-cmd": [
+      "php -r \"file_exists('.env') || copy('.env.example', '.env');\""
+    ]
   }
 }