Skip to content

Commit c6f0eff

Browse files
committed
docs: update readme
1 parent dc16e71 commit c6f0eff

File tree

1 file changed

+17
-41
lines changed

1 file changed

+17
-41
lines changed

README.md

Lines changed: 17 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
# Welcome to Telegram GitHub/GitLab Notifier 👋
22

3-
With this package, you can create a Telegram bot to receive notifications from GitHub or GitLab events
4-
and manage customization through messages and buttons on Telegram.
5-
63
<p align="center">
74
<img alt="Telegram GitHub/GitLab Notifier Laravel" src="resources/images/telegram-git-notifier-laravel.png" />
85
</p>
96

10-
![License](https://img.shields.io/github/license/cslant/laravel-telegram-git-notifier.svg?style=flat-square)
11-
[![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)
12-
[![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)
13-
![Test Status](https://img.shields.io/github/actions/workflow/status/cslant/laravel-telegram-git-notifier/setup_test.yml?label=tests&branch=main)
14-
![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)
15-
[![StyleCI](https://styleci.io/repos/683727144/shield)](https://styleci.io/repos/683727144)
16-
[![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)
17-
[![Maintainability](https://api.codeclimate.com/v1/badges/7ccaccebe9cd58ff3df5/maintainability)](https://codeclimate.com/github/cslant/laravel-telegram-git-notifier/maintainability)
7+
<p align="center">
8+
<a href="#"><img src="https://img.shields.io/github/license/cslant/laravel-telegram-git-notifier.svg?style=flat-square" alt="License"></a>
9+
<a href="https://github.com/cslant/laravel-telegram-git-notifier/releases"><img src="https://img.shields.io/github/release/cslant/laravel-telegram-git-notifier.svg?style=flat-square" alt="Latest Version"></a>
10+
<a href="https://packagist.org/packages/cslant/laravel-telegram-git-notifier"><img src="https://img.shields.io/packagist/dt/cslant/laravel-telegram-git-notifier.svg?style=flat-square" alt="Total Downloads"></a>
11+
<a href="https://github.com/cslant/laravel-telegram-git-notifier/actions/workflows/setup_test.yml"><img src="https://img.shields.io/github/actions/workflow/status/cslant/laravel-telegram-git-notifier/setup_test.yml?label=tests&branch=main" alt="Test Status"></a>
12+
<a href="https://github.com/cslant/laravel-telegram-git-notifier/actions/workflows/php-cs-fixer.yml"><img src="https://img.shields.io/github/actions/workflow/status/cslant/laravel-telegram-git-notifier/php-cs-fixer.yml?label=code%20style&branch=main" alt="Code Style Status"></a>
13+
<a href="https://scrutinizer-ci.com/g/cslant/laravel-telegram-git-notifier"><img src="https://img.shields.io/scrutinizer/g/cslant/laravel-telegram-git-notifier.svg?style=flat-square" alt="Quality Score"></a>
14+
<a href="https://codeclimate.com/github/cslant/laravel-telegram-git-notifier/maintainability"><img src="https://api.codeclimate.com/v1/badges/7ccaccebe9cd58ff3df5/maintainability" alt="Maintainability"></a>
15+
</p>
16+
17+
## 📝 Introduction
1818

19-
## 📝 Information
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.
2020

2121
- Send notifications of your GitHub/GitLab repositories to Telegram Bots, Groups, Super Groups (Multiple Topics), and Channels.
2222
- The bot must be created using the [BotFather](https://core.telegram.org/bots#6-botfather)
@@ -25,36 +25,12 @@ and manage customization through messages and buttons on Telegram.
2525

2626
- PHP ^8.1
2727
- [Composer](https://getcomposer.org/)
28-
- Core: [Telegram Git Notifier](https://github.com/cslant/telegram-git-notifier)
29-
30-
## 🔧 Installation
31-
32-
First, please clone and install this project via [Composer](https://getcomposer.org/):
33-
34-
```bash
35-
composer require cslant/laravel-telegram-git-notifier
36-
```
37-
38-
Publication of configuration files:
39-
40-
```bash
41-
php artisan vendor:publish --provider="CSlant\LaravelTelegramGitNotifier\Providers\TelegramGitNotifierServiceProvider" --tag="config_jsons"
42-
```
43-
44-
## Fixing Permissions (for Linux)
45-
46-
If you are using Linux, you need to change the owner of the configuration files to the web server user and group (e.g. `www-data`).
47-
48-
The configuration files will be used to store the bot's settings and other information, so you need to change the owner of the configuration files to the web server user and group.
28+
- Core: [Telegram Git Notifier](https://github.com/cslant/telegram-git-notifier.git)
4929

50-
```bash
51-
sudo php artisan config-json:change-owner www-data www-data
52-
```
30+
## 📖 Official Documentation
5331

54-
> Note:
55-
> - `www-data` is the user and group of the web server, you can change it to your own user and group.
56-
> - The first `www-data` is the user, and the second `www-data` is the group. (You can also use only the first `www-data` to represent both the user and the group)
32+
Please see the [Telegram Git Notifier Documentation](https://docs.cslant.com/telegram-git-notifier/) for more information.
5733

58-
## 📖 Documentation
34+
## License
5935

60-
Please see the [Telegram Git Notifier Documentation](https://docs.cslant.com/telegram-git-notifier/introduction) for more information.
36+
The MIT License (MIT). Please see [License File](LICENSE) for more information.

0 commit comments

Comments
 (0)