Update README.md

Author: tanhongit

README.md

@@ -1 +1,32 @@
-# laravel-telegram-git-notify
+# Welcome to Telegram GitHub/GitLab Notifier 👋
+
+With this package, you can create a Telegram bot to receive notifications from GitHub or GitLab events
+and manage customization through messages and buttons on Telegram.
+
+![License](https://img.shields.io/github/license/cslant/laravel-telegram-git-notifier.svg?style=flat-square)
+[![Latest Version](https://img.shields.io/github/release/cslant/laravel-telegram-git-notifier.svg?style=flat-square)](https://github.com/cslant/laravel-telegram-git-notifier/releases)
+[![Total Downloads](https://img.shields.io/packagist/dt/cslant/laravel-telegram-git-notifier.svg?style=flat-square)](https://packagist.org/packages/cslant/laravel-telegram-git-notifier)
+![Test Status](https://img.shields.io/github/actions/workflow/status/cslant/laravel-telegram-git-notifier/setup_test.yml?label=tests&branch=main)
+![Code Style Status](https://img.shields.io/github/actions/workflow/status/cslant/laravel-telegram-git-notifier/php-cs-fixer.yml?label=code%20style&branch=main)
+[![StyleCI](https://styleci.io/repos/656960426/shield)](https://styleci.io/repos/656960426)
+[![Quality Score](https://img.shields.io/scrutinizer/g/cslant/laravel-telegram-git-notifier.svg?style=flat-square)](https://scrutinizer-ci.com/g/cslant/laravel-telegram-git-notifier)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7ccaccebe9cd58ff3df5/maintainability)](https://codeclimate.com/github/cslant/laravel-telegram-git-notifier/maintainability)
+
+## 📝 Information
+
+- Send notifications of your GitHub/GitLab repositories to Telegram Bots, Groups, Super Groups (Multiple Topics), and Channels.
+- The bot must be created using the [BotFather](https://core.telegram.org/bots#6-botfather)
+
+## 📋 Requirements
+
+- PHP ^8.1
+- [Composer](https://getcomposer.org/)
+- Core: [Telegram Git Notifier](https://github.com/cslant/telegram-git-notifier)
+
+## 🔧 Installation
+
+First, please clone and install this project via [Composer](https://getcomposer.org/):
+
+```bash
+composer require cslant/laravel-telegram-git-notifier
+```