Skip to content

Commit 3ebb717

Browse files
committed
add notes on ably drivers
1 parent 09a64a1 commit 3ebb717

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

broadcasting.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,9 @@ The [laravel-websockets](https://github.com/beyondcode/laravel-websockets) and [
115115
<a name="ably"></a>
116116
### Ably
117117

118+
> **Note**
119+
> The documentation below discusses how to use Ably in "Pusher compatibility" mode. However, the Ably team maintains a broadcaster and Echo client that is able to take advantage of the unique capabilities offered by Ably. For more information on using the Ably maintained drivers, please [consult Ably's Laravel broadcaster documentation](https://github.com/ably/laravel-broadcaster).
120+
118121
If you plan to broadcast your events using [Ably](https://ably.com), you should install the Ably PHP SDK using the Composer package manager:
119122

120123
```shell
@@ -208,6 +211,9 @@ window.Echo = new Echo({
208211
<a name="client-ably"></a>
209212
### Ably
210213

214+
> **Note**
215+
> The documentation below discusses how to use Ably in "Pusher compatibility" mode. However, the Ably team maintains a broadcaster and Echo client that is able to take advantage of the unique capabilities offered by Ably. For more information on using the Ably maintained drivers, please [consult Ably's Laravel broadcaster documentation](https://github.com/ably/laravel-broadcaster).
216+
211217
[Laravel Echo](https://github.com/laravel/echo) is a JavaScript library that makes it painless to subscribe to channels and listen for events broadcast by your server-side broadcasting driver. You may install Echo via the NPM package manager. In this example, we will also install the `pusher-js` package.
212218

213219
You may wonder why we would install the `pusher-js` JavaScript library even though we are using Ably to broadcast our events. Thankfully, Ably includes a Pusher compatibility mode which lets us use the Pusher protocol when listening for events in our client-side application:

0 commit comments

Comments
 (0)