| 1 | <p align="center"><img src="/art/logo.svg" alt="Logo Laravel Echo"></p>
|
| 2 |
|
| 3 | <p align="center">
|
| 4 | <a href="https://github.com/laravel/echo/actions"><img src="https://github.com/laravel/echo/workflows/tests/badge.svg" alt="Build Status"></a>
|
| 5 | <a href="https://www.npmjs.com/package/laravel-echo"><img src="https://img.shields.io/npm/dt/laravel-echo" alt="Total Downloads"></a>
|
| 6 | <a href="https://www.npmjs.com/package/laravel-echo"><img src="https://img.shields.io/npm/v/laravel-echo" alt="Latest Stable Version"></a>
|
| 7 | <a href="https://www.npmjs.com/package/laravel-echo"><img src="https://img.shields.io/npm/l/laravel-echo" alt="License"></a>
|
| 8 | </p>
|
| 9 |
|
| 10 | ## Introduction
|
| 11 |
|
| 12 | In many modern web applications, WebSockets are used to implement realtime, live-updating user interfaces. When some data is updated on the server, a message is typically sent over a WebSocket connection to be handled by the client. This provides a more robust, efficient alternative to continually polling your application for changes.
|
| 13 |
|
| 14 | To assist you in building these types of applications, Laravel makes it easy to "broadcast" your events over a WebSocket connection. Broadcasting your Laravel events allows you to share the same event names between your server-side code and your client-side JavaScript application.
|
| 15 |
|
| 16 | Laravel Echo is a JavaScript library that makes it painless to subscribe to channels and listen for events broadcast by Laravel. You may install Echo via the NPM package manager.
|
| 17 |
|
| 18 | ## Official Documentation
|
| 19 |
|
| 20 | Documentation for Echo can be found on the [Laravel website](https://laravel.com/docs/broadcasting).
|
| 21 |
|
| 22 | ## Contributing
|
| 23 |
|
| 24 | Thank you for considering contributing to Echo! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
|
| 25 |
|
| 26 | ## Code of Conduct
|
| 27 |
|
| 28 | In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
|
| 29 |
|
| 30 | ## Security Vulnerabilities
|
| 31 |
|
| 32 | Please review [our security policy](https://github.com/laravel/echo/security/policy) on how to report security vulnerabilities.
|
| 33 |
|
| 34 | ## License
|
| 35 |
|
| 36 | Laravel Echo is open-sourced software licensed under the [MIT license](LICENSE.md).
|