Clarify package intent (#57)

* Clarify package intent

* Update README.md

Co-authored-by: Nate Bosch <nbosch@google.com>

Co-authored-by: Nate Bosch <nbosch@google.com>
1 file changed
tree: f797047a7219a18508868b03251fe6528ba46966
  1. .github/
  2. example/
  3. lib/
  4. test/
  5. .gitignore
  6. analysis_options.yaml
  7. AUTHORS
  8. CHANGELOG.md
  9. CONTRIBUTING.md
  10. LICENSE
  11. pubspec.yaml
  12. README.md
README.md

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 sink and 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.