|author||Gary Roumanis <email@example.com>||Wed Sep 01 11:42:23 2021 -0700|
|committer||GitHub <firstname.lastname@example.org>||Wed Sep 01 11:42:23 2021 -0700|
Clarify package intent (#57) * Clarify package intent * Update README.md Co-authored-by: Nate Bosch <email@example.com> Co-authored-by: Nate Bosch <firstname.lastname@example.org>
This package provides support for bi-directional communication through Server Sent Events and corresponding POST requests.
This package is not intended to be a general purpose SSE package, but instead is a bidirectional protocol for use when Websockets are unavailable. That is, both the client and the server expose a
stream on which to send and receive messages respectively.
Both the server and client have implicit assumptions on each other and therefore a client from this package must be paired with a server from this package.