summaryrefslogtreecommitdiffstats
path: root/examples/websocket/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/websocket/README.md')
-rw-r--r--examples/websocket/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/examples/websocket/README.md b/examples/websocket/README.md
new file mode 100644
index 00000000..fcdee9f3
--- /dev/null
+++ b/examples/websocket/README.md
@@ -0,0 +1,12 @@
+## Websocket
+
+A simple example that keeps a WebSocket connection open to an echo server.
+
+The __[`main`]__ file contains all the code of the example.
+
+You can run it with `cargo run`:
+```
+cargo run --package websocket
+```
+
+[`main`]: src/main.rs