summaryrefslogtreecommitdiffstats
path: root/tokio/README.md
diff options
context:
space:
mode:
authorjohnnydai0 <66202462+johnnydai0@users.noreply.github.com>2020-06-11 16:51:49 +0800
committerGitHub <noreply@github.com>2020-06-11 10:51:49 +0200
commitadaa6849a5be397a0578540939c2c2031681d8ea (patch)
treeaedaf69465b630050ad8a0fa28dfa7796f10d9c5 /tokio/README.md
parent0a422593f0196840a176895cb3394c3c3314fdb2 (diff)
docs: fix the link of contributing guide (#2577)
Diffstat (limited to 'tokio/README.md')
-rw-r--r--tokio/README.md50
1 files changed, 30 insertions, 20 deletions
diff --git a/tokio/README.md b/tokio/README.md
index 080181f8..5a661998 100644
--- a/tokio/README.md
+++ b/tokio/README.md
@@ -24,12 +24,13 @@ the Rust programming language. It is:
[azure-badge]: https://dev.azure.com/tokio-rs/Tokio/_apis/build/status/tokio-rs.tokio?branchName=master
[azure-url]: https://dev.azure.com/tokio-rs/Tokio/_build/latest?definitionId=1&branchName=master
[discord-badge]: https://img.shields.io/discord/500028886025895936.svg?logo=discord&style=flat-square
-[discord-url]: https://discord.gg/6yGkFeN
+[discord-url]: https://discord.gg/tokio
[Website](https://tokio.rs) |
-[Guides](https://tokio.rs/docs/) |
-[API Docs](https://docs.rs/tokio/0.2/tokio) |
-[Chat](https://discord.gg/6yGkFeN)
+[Guides](https://tokio.rs/docs/overview/) |
+[API Docs](https://docs.rs/tokio/latest/tokio) |
+[Roadmap](https://github.com/tokio-rs/tokio/blob/master/ROADMAP.md) |
+[Chat](https://discord.gg/tokio)
## Overview
@@ -45,20 +46,11 @@ level, it provides a few major components:
These components provide the runtime components necessary for building
an asynchronous application.
-[net]: https://docs.rs/tokio/0.2/tokio/net/index.html
-[scheduler]: https://docs.rs/tokio/0.2/tokio/runtime/index.html
+[net]: https://docs.rs/tokio/latest/tokio/net/index.html
+[scheduler]: https://docs.rs/tokio/latest/tokio/runtime/index.html
## Example
-To get started, add the following to `Cargo.toml`.
-
-```toml
-tokio = { version = "0.2", features = ["full"] }
-```
-
-Tokio requires components to be explicitly enabled using feature flags. As a
-shorthand, the `full` feature enables all components.
-
A basic TCP echo server with Tokio:
```rust,no_run
@@ -98,7 +90,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
}
```
-More examples can be found [here](../examples).
+More examples can be found [here](examples).
## Getting Help
@@ -107,9 +99,9 @@ First, see if the answer to your question can be found in the [Guides] or the
the [Tokio Discord server][chat]. We would be happy to try to answer your
question. Last, if that doesn't work, try opening an [issue] with the question.
-[Guides]: https://tokio.rs/docs/
-[API documentation]: https://docs.rs/tokio/0.2
-[chat]: https://discord.gg/6yGkFeN
+[Guides]: https://tokio.rs/docs/overview/
+[API documentation]: https://docs.rs/tokio/latest/tokio
+[chat]: https://discord.gg/tokio
[issue]: https://github.com/tokio-rs/tokio/issues/new
## Contributing
@@ -118,21 +110,39 @@ question. Last, if that doesn't work, try opening an [issue] with the question.
you! We have a [contributing guide][guide] to help you get involved in the Tokio
project.
-[guide]: CONTRIBUTING.md
+[guide]: https://github.com/tokio-rs/tokio/blob/master/CONTRIBUTING.md
## Related Projects
In addition to the crates in this repository, the Tokio project also maintains
several other libraries, including:
+* [`hyper`]: A fast and correct HTTP/1.1 and HTTP/2 implementation for Rust.
+
+* [`tonic`]: A gRPC over HTTP/2 implementation focused on high performance, interoperability, and flexibility.
+
+* [`warp`]: A super-easy, composable, web server framework for warp speeds.
+
+* [`tower`]: A library of modular and reusable components for building robust networking clients and servers.
+
* [`tracing`] (formerly `tokio-trace`): A framework for application-level
tracing and async-aware diagnostics.
+* [`rdbc`]: A Rust database connectivity library for MySQL, Postgres and SQLite.
+
* [`mio`]: A low-level, cross-platform abstraction over OS I/O APIs that powers
`tokio`.
* [`bytes`]: Utilities for working with bytes, including efficient byte buffers.
+* [`loom`]: A testing tool for concurrent Rust code
+
+[`warp`]: https://github.com/seanmonstar/warp
+[`hyper`]: https://github.com/hyperium/hyper
+[`tonic`]: https://github.com/hyperium/tonic
+[`tower`]: https://github.com/tower-rs/tower
+[`loom`]: https://github.com/tokio-rs/loom
+[`rdbc`]: https://github.com/tokio-rs/rdbc
[`tracing`]: https://github.com/tokio-rs/tracing
[`mio`]: https://github.com/tokio-rs/mio
[`bytes`]: https://github.com/tokio-rs/bytes