Releasing version 0.9.0

Author: LaunchDarklyReleaseBot

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to the project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [0.9.0] - 2022-03-15
+### Added:
+- Added support for SSE test harness.
+
+### Changed:
+- Change `ClientBuilder` to return `impl Client`, where `Client` is a sealed trait that exposes a `stream()` method. 
+
+### Fixed:
+- Fixed various bugs related to SSE protocol.
+
 ## [0.8.2] - 2022-02-03
 ### Added:
 - Support for creating an event source client with a pre-configured connection.

README.md

@@ -0,0 +1,44 @@
+# eventsource-client
+
+Client for the [Server-Sent Events] protocol (aka [EventSource]).
+
+[Server-Sent Events]: https://html.spec.whatwg.org/multipage/server-sent-events.html
+[EventSource]: https://developer.mozilla.org/en-US/docs/Web/API/EventSource
+
+## Requirements
+
+Requires tokio.
+
+## Usage
+
+Example that just prints the type of each event received:
+
+```rust
+use eventsource_client as es;
+
+let mut client = es::ClientBuilder::for_url("https://example.com/stream")?
+    .header("Authorization", "Basic username:password")?
+    .build();
+
+client
+    .stream()
+    .map_ok(|event| println!("got event: {:?}", event))
+    .map_err(|err| eprintln!("error streaming events: {:?}", err));
+```
+
+(Some boilerplate omitted for clarity; see [examples directory] for complete,
+working code.)
+
+[examples directory]: https://github.com/launchdarkly/rust-eventsource-client/tree/master/eventsource-client/examples
+## Features
+
+* tokio-based streaming client.
+* Supports setting custom headers on the HTTP request (e.g. for endpoints
+  requiring authorization).
+* Retry for failed connections.
+* Reconnection if connection is interrupted, with exponential backoff.
+
+## Stability
+
+Early stage release for feedback purposes. May contain bugs or performance
+issues. API subject to change.

README.md

@@ -1,6 +1,6 @@
 [package]
 name = "eventsource-client"
-version = "0.8.2"
+version = "0.9.0"
 description = "Client for the Server-Sent Events protocol (aka EventSource)"
 repository = "https://github.com/launchdarkly/rust-eventsource-client"
 authors = ["LaunchDarkly"]