summaryrefslogtreecommitdiffstats
path: root/examples/websocket/README.md
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón <hector0193@gmail.com>2022-01-17 21:46:17 +0700
committerLibravatar GitHub <noreply@github.com>2022-01-17 21:46:17 +0700
commit92a699b97dacd4c40316b67e20b6a3a777a1de64 (patch)
tree06ab57aaf4dada3a5b7cef6f331a22c47183ac5e /examples/websocket/README.md
parentb7bc169120d3447ead238e974007027a5152d341 (diff)
parent5ce8653fb51c035e0a6fe1ba7ab363018cdf107b (diff)
downloadiced-92a699b97dacd4c40316b67e20b6a3a777a1de64.tar.gz
iced-92a699b97dacd4c40316b67e20b6a3a777a1de64.tar.bz2
iced-92a699b97dacd4c40316b67e20b6a3a777a1de64.zip
Merge pull request #1198 from iced-rs/subscription-helpers
`websocket` example and helpers to create custom subscriptions
Diffstat (limited to 'examples/websocket/README.md')
-rw-r--r--examples/websocket/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/examples/websocket/README.md b/examples/websocket/README.md
new file mode 100644
index 00000000..16e983da
--- /dev/null
+++ b/examples/websocket/README.md
@@ -0,0 +1,17 @@
+## Websocket
+
+A simple example that keeps a WebSocket connection open to an echo server.
+
+The example consists of 3 modules:
+- [`main`] contains the `Application` logic.
+- [`echo`] implements a WebSocket client for the [`echo::server`] with `async-tungstenite`.
+- [`echo::server`] implements a simple WebSocket echo server with `warp`.
+
+You can run it with `cargo run`:
+```
+cargo run --package websocket
+```
+
+[`main`]: src/main.rs
+[`echo`]: src/echo.rs
+[`echo::server`]: src/echo/server.rs