summaryrefslogtreecommitdiffstats
path: root/examples/proxy.rs
diff options
context:
space:
mode:
authorAlex Crichton <alex@alexcrichton.com>2017-09-11 13:30:45 -0700
committerAlex Crichton <alex@alexcrichton.com>2017-09-11 13:31:08 -0700
commitecedea3404a04614da967c6a43a3f802573c9261 (patch)
tree10a2cbd7770589a91a71c96ba48bb69d07f23bdd /examples/proxy.rs
parent2e5cd1640e9c93d6374a152554dedd212939aab8 (diff)
Add a README for the examples
Diffstat (limited to 'examples/proxy.rs')
-rw-r--r--examples/proxy.rs15
1 files changed, 15 insertions, 0 deletions
diff --git a/examples/proxy.rs b/examples/proxy.rs
index 4920cc9f..7bc53819 100644
--- a/examples/proxy.rs
+++ b/examples/proxy.rs
@@ -1,5 +1,20 @@
//! A proxy that forwards data to another server and forwards that server's
//! responses back to clients.
+//!
+//! You can showcase this by running this in one terminal:
+//!
+//! cargo run --example proxy
+//!
+//! This in another terminal
+//!
+//! cargo run --example echo
+//!
+//! And finally this in another terminal
+//!
+//! cargo run --example connect 127.0.0.1:8081
+//!
+//! This final terminal will connect to our proxy, which will in turn connect to
+//! the echo server, and you'll be able to see data flowing between them.
extern crate futures;
extern crate tokio_core;