summaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2022-01-16 19:59:59 +0700
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2022-01-16 19:59:59 +0700
commit88f1168a0b58759efb622c0215edd3d6b23bd059 (patch)
tree1e023a03576e723eade66cd2b587962c444b84e9 /examples
parentdc50a2830ab553dfc5dfc28d4fd1af6b3981c656 (diff)
downloadiced-88f1168a0b58759efb622c0215edd3d6b23bd059.tar.gz
iced-88f1168a0b58759efb622c0215edd3d6b23bd059.tar.bz2
iced-88f1168a0b58759efb622c0215edd3d6b23bd059.zip
Update `README` file of `websocket` example
Diffstat (limited to 'examples')
-rw-r--r--examples/websocket/README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/examples/websocket/README.md b/examples/websocket/README.md
index fcdee9f3..16e983da 100644
--- a/examples/websocket/README.md
+++ b/examples/websocket/README.md
@@ -2,7 +2,10 @@
A simple example that keeps a WebSocket connection open to an echo server.
-The __[`main`]__ file contains all the code of the example.
+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`:
```
@@ -10,3 +13,5 @@ cargo run --package websocket
```
[`main`]: src/main.rs
+[`echo`]: src/echo.rs
+[`echo::server`]: src/echo/server.rs