Skip to content

Commit

Permalink
doc: fix old notes regarding examples and async/await (tokio-rs#2071)
Browse files Browse the repository at this point in the history
  • Loading branch information
Darksonn authored and carllerche committed Jan 7, 2020
1 parent 7fb5431 commit 7ee5542
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 14 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
22 changes: 18 additions & 4 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -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/
6 changes: 1 addition & 5 deletions tokio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 7ee5542

Please sign in to comment.