diff options
| -rw-r--r-- | README.md | 6 | ||||
| -rw-r--r-- | examples/README.md | 22 | ||||
| -rw-r--r-- | tokio/README.md | 6 |
3 files changed, 20 insertions, 14 deletions
@@ -90,11 +90,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { } ``` -More examples can be found [here](examples). Note that 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). - +More examples can be found [here](examples). ## Getting Help 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/ diff --git a/tokio/README.md b/tokio/README.md index 297a4eb8..080181f8 100644 --- a/tokio/README.md +++ b/tokio/README.md @@ -98,11 +98,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> { } ``` -More examples can be found [here](../examples). Note that 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). - +More examples can be found [here](../examples). ## Getting Help |