Add chat example documentation. (#85)

Cargo.toml

@@ -80,3 +80,7 @@ rustdoc-args = ["--cfg", "docsrs"]
 
 [package.metadata.playground]
 features = ["ws"]
+
+[[example]]
+name = "chat"
+required-features = ["ws"]

examples/README.md

@@ -15,3 +15,4 @@
 - [`unix_domain_socket`](../examples/unix_domain_socket.rs) - How to run an Axum server over unix domain sockets.
 - [`sessions`](../examples/sessions.rs) - Sessions and cookies using [`async-session`](https://crates.io/crates/async-session).
 - [`tls_rustls`](../examples/tls_rustls.rs) - TLS with [`tokio-rustls`](https://crates.io/crates/tokio-rustls).
+- [`chat`](../examples/chat.rs) - Chat application example.

examples/chat.rs

@@ -1,3 +1,11 @@
+//! Example chat application.
+//!
+//! Run with
+//!
+//! ```
+//! cargo run --features=ws --example chat
+//! ```
+
 use std::collections::HashSet;
 use std::net::SocketAddr;
 use std::sync::{Arc, Mutex};