From a5660cee733165b352233abeb2508bad88aec844 Mon Sep 17 00:00:00 2001 From: Joe Dixon Date: Thu, 7 Dec 2023 15:55:41 +0000 Subject: [PATCH] update readme --- README.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/README.md b/README.md index 9bca56f5..3dc3dfa5 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,6 @@ Laravel Reverb brings real-time WebSocket communication for Laravel applications. -_____ - ## Architecture ### Message Lifecycle @@ -49,19 +47,13 @@ Reverb supports seven channel types: ### API Gateway The API Gateway implementation leverages the WebSocket API type. The user connects and the request is sent to Lambda for processing. When a user connects, disconnects or sends a message it is sent via API Gateway to Lambda. Reverb takes the request creates a Reverb Connection object from it and sends the payload on to the Reverb server for processing. The channel manager cannot be in memory, so a cache manager is used instead. Messages cannot be sent in response to the request so, instead are queued and posted to the endpoint provided by AWS. In turn, they send the message on to the user. -_____ - ## Outstanding - [ ] **Pulse Card(s)** - this can interact with some of the addtional Pusher endpoints in order to show channels and connections -_____ - ## Considerations - The WebSocket specification has a concept of extensions. They are completely optional and Reverb doesn't support them right now. There is only really one official extension which allows inflating and deflating messages. Moving forward, it could be possible to add hooks / middleware to the message lifecycle to allow forextensions such as permessage-deflate, but also to allow others to implement their own. - Pusher now allow opt-in access to something called [Watchlists](https://pusher.com/docs/channels/using_channels/watchlist-events/). It could be possible to look at implementing this functionality. -_____ - ### Installation Add the following `repostories` block to your `composer.json` file.