diff options
| author | Alice Ryhl <alice@ryhl.io> | 2020-01-08 00:55:10 +0100 |
|---|---|---|
| committer | Carl Lerche <me@carllerche.com> | 2020-01-07 15:55:10 -0800 |
| commit | 7ee554218208a9f3919d840079bd96c6ba881caf (patch) | |
| tree | 1998ff8fd3917619d83389310ca7b67e68d1e314 /examples | |
| parent | 7fb54315f1e1b12fc94558ada85ed521aea3ae77 (diff) | |
doc: fix old notes regarding examples and async/await (#2071)
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/README.md | 22 |
1 files changed, 18 insertions, 4 deletions
diff --git a/examples/README.md b/examples/README.md index 802d0aa4..8217d4c6 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,6 +1,20 @@ ## Examples of how to use Tokio -The `master` branch is currently being updated to use `async` / `await`. -The examples are not fully ported. Examples for stable Tokio can be -found -[here](https://github.com/tokio-rs/tokio/tree/v0.1.x/tokio/examples). +This directory contains a number of examples showcasing various capabilities of +the `tokio` crate. + +All examples can be executed with: + +``` +cargo run --example $name +``` + +A good starting point for the examples would be [`hello_world`](hello_world.rs) +and [`echo`](echo.rs). Additionally [the tokio website][tokioweb] contains +additional guides for some of the examples. + +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 +to make a PR! + +[tokioweb]: https://tokio.rs/docs/overview/ |