laravel-websockets/README.md

40 lines
2.0 KiB
Markdown
Raw Normal View History

2018-11-30 14:07:34 +00:00
# Laravel WebSockets 🛰
2018-11-20 08:54:06 +00:00
2024-02-07 17:30:25 +00:00
> [!NOTE]
> Laravel WebSockets is no longer maintained. If you are looking for a PHP-based WebSocket solution, check out [Laravel Reverb](https://reverb.laravel.com) which is also built on top of ReactPHP and allows you to horizontally scale the WebSocket server.
2018-11-20 08:54:06 +00:00
[![Latest Version on Packagist](https://img.shields.io/packagist/v/beyondcode/laravel-websockets.svg?style=flat-square)](https://packagist.org/packages/beyondcode/laravel-websockets)
2020-03-04 09:58:17 +00:00
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/beyondcode/laravel-websockets/run-tests?label=tests)
2018-11-20 08:54:06 +00:00
[![Quality Score](https://img.shields.io/scrutinizer/g/beyondcode/laravel-websockets.svg?style=flat-square)](https://scrutinizer-ci.com/g/beyondcode/laravel-websockets)
[![Total Downloads](https://img.shields.io/packagist/dt/beyondcode/laravel-websockets.svg?style=flat-square)](https://packagist.org/packages/beyondcode/laravel-websockets)
2018-12-04 19:27:52 +00:00
Bring the power of WebSockets to your Laravel application. Drop-in Pusher replacement, SSL support, Laravel Echo support and a debug dashboard are just some of its features.
2018-11-20 08:54:06 +00:00
2022-09-16 10:56:48 +00:00
[![https://tinkerwell.app/?ref=github](https://tinkerwell.app/images/card-v3.png)](https://tinkerwell.app/?ref=github)
2018-12-09 10:06:23 +00:00
2018-12-04 23:48:30 +00:00
## Documentation
2018-12-04 21:36:12 +00:00
2022-09-16 10:56:48 +00:00
For installation instructions, in-depth usage and deployment details, please take a look at the [official documentation](https://beyondco.de/docs/laravel-websockets/getting-started/introduction/).
2018-11-20 08:54:06 +00:00
### Changelog
2018-12-05 00:52:26 +00:00
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
2018-11-20 08:54:06 +00:00
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please email marcel@beyondco.de instead of using the issue tracker.
## Credits
- [Marcel Pociot](https://github.com/mpociot)
2018-11-21 23:26:09 +00:00
- [Freek Van der Herten](https://github.com/freekmurze)
2018-11-20 08:54:06 +00:00
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.