laravel-madeline-proto/README.md
2020-11-21 00:44:22 +07:00

44 lines
2.0 KiB
Markdown

# Laravel MadelineProto
[![Latest Stable Version](https://poser.pugx.org/setiawanhu/laravel-madeline-proto/v)](//packagist.org/packages/setiawanhu/laravel-madeline-proto)
[![Total Downloads](https://poser.pugx.org/setiawanhu/laravel-madeline-proto/downloads)](//packagist.org/packages/setiawanhu/laravel-madeline-proto)
[![License](https://poser.pugx.org/setiawanhu/laravel-madeline-proto/license)](//packagist.org/packages/setiawanhu/laravel-madeline-proto)
A third party Telegram client library [danog/MadelineProto](https://github.com/danog/MadelineProto) wrapper for Laravel.
# Getting Started
Add the laravel-madeline-proto to the project dependency:
```shell script
composer require setiawanhu/laravel-madeline-proto
```
Then publish the `telegram.php` config file:
```shell script
php artisan vendor:publish --provider="Hu\MadelineProto\MadelineProtoServiceProvider"
```
Set up the Telegram API key by providing env variables:
```dotenv
MP_TELEGRAM_API_ID=... //your telegram api id here
MP_TELEGRAM_API_HASH=... //your telegram api hash here
```
This wrapper package supports for running both [single](https://github.com/setiawanhu/laravel-madeline-proto/wiki/Single-Telegram-Account) / [multiple](https://github.com/setiawanhu/laravel-madeline-proto/wiki/Multiple-Telegram-Account) telegram account.
## Dig Deeper
Please check [wiki](https://github.com/setiawanhu/laravel-madeline-proto/wiki) for more details about laravel-madeline-proto usage
# Notes
* This wrapper package is still not wrapping all the apis yet, I'm still focusing on wrapping the messages api.
* If you can't find the method that you want in Messages facade or need to use the default danog/MadelineProto api, you might want to use `MadelineProto::getClient()` facade method. It will return `danog\MadelineProto\API` object where you can call all the method provided by the [danog/MadelineProto](https://github.com/danog/MadelineProto) library.
# Thanks To
[Bryan Ramaputra](https://github.com/Ordinal43) for helping me to write readable documentations.