diff options
Diffstat (limited to 'examples/websocket/README.md')
| -rw-r--r-- | examples/websocket/README.md | 17 |
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 |