forked from tokio-rs/tokio
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: fix old notes regarding examples and async/await (tokio-rs#2071)
- Loading branch information
1 parent
7fb5431
commit 7ee5542
Showing
3 changed files
with
20 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters