summaryrefslogtreecommitdiffstats
path: root/examples/README.md
diff options
context:
space:
mode:
authorCarl Lerche <me@carllerche.com>2018-03-07 22:28:01 -0800
committerGitHub <noreply@github.com>2018-03-07 22:28:01 -0800
commit264fef60e3640d8c97fdaf0b67ec0c0da32fdf71 (patch)
tree393cc41f9c97d3a9ab7d71d42eb4350bdbc0d2f3 /examples/README.md
parent25dd54d263356a77406036411ec29442305418e2 (diff)
Update readme (#196)
Diffstat (limited to 'examples/README.md')
-rw-r--r--examples/README.md52
1 files changed, 27 insertions, 25 deletions
diff --git a/examples/README.md b/examples/README.md
index 916c2cc0..d0c4d45f 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -11,39 +11,41 @@ cargo run --example $name
A high level description of each example is:
-* `hello_world` - a tiny server that writes "hello world" to all connected
- clients and then terminates the connection, should help see how to create and
- initialize `tokio`.
+* [`hello_world`](hello_world.rs) - a tiny server that writes "hello world" to
+ all connected clients and then terminates the connection, should help see how
+ to create and initialize `tokio`.
-* `echo` - this is your standard TCP "echo server" which accepts connections and
- then echos back any contents that are read from each connected client.
+* [`echo`](echo.rs) - this is your standard TCP "echo server" which accepts
+ connections and then echos back any contents that are read from each connected
+ client.
-* `echo-udp` - again your standard "echo server", except for UDP instead of TCP.
- This will echo back any packets received to the original sender.
+* [`echo-udp`](echo-udp.rs) - again your standard "echo server", except for UDP
+ instead of TCP. This will echo back any packets received to the original
+ sender.
-* `connect` - this is a `nc`-like clone which can be used to interact with most
- other examples. The program creates a TCP connection or UDP socket to sends
- all information read on stdin to the remote peer, displaying any data received
- on stdout. Often quite useful when interacting with the various other servers
- here!
+* [`connect`](connect.rs) - this is a `nc`-like clone which can be used to
+ interact with most other examples. The program creates a TCP connection or UDP
+ socket to sends all information read on stdin to the remote peer, displaying
+ any data received on stdout. Often quite useful when interacting with the
+ various other servers here!
-* `chat` - this spins up a local TCP server which will broadcast from any
- connected client to all other connected clients. You can connect to this in
- multiple terminals and use it to chat between the terminals.
+* [`chat`](chat.rs) - this spins up a local TCP server which will broadcast from
+ any connected client to all other connected clients. You can connect to this
+ in multiple terminals and use it to chat between the terminals.
-* `chat-combinator` - Similar to `chat`, but this uses a much more functional
- programming approch using combinators.
+* [`chat-combinator`](chat-combinator.rs) - Similar to `chat`, but this uses a
+ much more functional programming approch using combinators.
-* `proxy` - an example proxy server that will forward all connected TCP clients
- to the remote address specified when starting the program.
+* [`proxy`](proxy.rs) - an example proxy server that will forward all connected
+ TCP clients to the remote address specified when starting the program.
-* `tinyhttp` - a tiny HTTP/1.1 server which doesn't support HTTP request bodies
- showcasing running on multiple cores, working with futures and spawning
- tasks, and finally framing a TCP connection to discrete request/response
- objects.
+* [`tinyhttp`](tinyhttp.rs) - a tiny HTTP/1.1 server which doesn't support HTTP
+ request bodies showcasing running on multiple cores, working with futures and
+ spawning tasks, and finally framing a TCP connection to discrete
+ request/response objects.
-* `tinydb` - an in-memory database which shows sharing state between all
- connected clients, notably the key/value store of this database.
+* [`tinydb`](tinyhttp.rs) - an in-memory database which shows sharing state
+ between all connected clients, notably the key/value store of this database.
If you've got an example you'd like to see here, please feel free to open an
issue. Otherwise if you've got an example you'd like to add, please feel free