diff --git a/README.md b/README.md index 20f7396..181b73a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # eventsource -A library for using EventSource or Server-Side Events (SSE). +A library for using EventSource or Server-Sent Events (SSE). Both client and server functionality is provided. +This library implements the interface as described [here](https://html.spec.whatwg.org/multipage/comms.html#server-sent-events). + ## Client usage For more advanced usage, see the `example/` directory. @@ -20,7 +22,7 @@ EventSource eventSource = await EventSource.connect("http://example.com/events", ## Server usage We recommend using [`shelf_eventsource`](https://pub.dartlang.org/packages/shelf_eventsource) for -serving Server-Side Events. +serving Server-Sent Events. This library provides an `EventSourcePublisher` that manages subscriptions, channels, encoding. We refer to documentation in the [`shelf_eventsource`](https://pub.dartlang.org/packages/shelf_eventsource) package for more information. diff --git a/pubspec.yaml b/pubspec.yaml index d052085..dbf4c80 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: eventsource -description: A client and server implementation of Server-Side Events. -version: 0.1.0 +description: A client and server implementation of Server-Sent Events. +version: 0.1.0+1 author: Steven Roose homepage: https://github.com/stevenroose/dart-eventsource