Telepath for Laravel

Laravel integration for Telepath
Explore the docs »

Report Bug

Table of Contents

1. About The Project
2. Getting Started
3. Usage
4. Known Limitations
5. Contributing
6. License
7. Contact

About The Project

Telepath is a modern framework-agnostic libraray to create Telegram Bots in PHP.

This package integrates a Telepath based bot into your Laravel application being able to receive and respond to Telegram messages your bot receives.

(back to top)

Getting Started

This package can be installed via composer:

composer require telepath/laravel

The package will automatically install the required dependencies to use Telepath in your Laravel application.

(back to top)

Usage

You can get the Bot instance via the Telepath facade.

$bot = \Telepath::bot();

or by using autowiring to request an instance.

public function __construct(
    protected Telepath\Bot $bot
) {}

For a more detailled look including how to integrate Telepath into your Laravel application please also have a look into our Documentation

(back to top)

Known Limitations

Please note that this package currently has the following limitations:

• Handling multiple bots in the same Laravel application is not supported yet.
• Support for Lumen or other Laravel subset frameworks is not officially supported.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Tii - @TiiFuchs - mail@tii.one

Project Link: https://github.com/telepath-php/laravel

(back to top)