summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEliza Weisman <eliza@buoyant.io>2019-06-28 13:13:46 -0700
committerGitHub <noreply@github.com>2019-06-28 13:13:46 -0700
commitaf46eac5837af4871144923b1e75f38c41e8896d (patch)
treece582f445bfda6d2af52dc22dbde5f89c97f673d /README.md
parente7488d983e025d1b3c025b33009dc3055b966e16 (diff)
chore: remove `tokio-trace`, add "Related Projects" to README (#1221)
## Motivation The `tokio-trace` and `tokio-trace-core` crates have been renamed to `tracing` and `tracing-core`, and moved to their own repository (`tokio-rs/tracing`). ## Solution This branch removes `tokio-trace` and `tokio-trace-core` from the `tokio` repository. In addition, I've added a "Related Projects" section to the root README, which lists `tracing` (as well as `mio`, and `bytes`) as other libraries maintained by the Tokio project. I thought that this would help folks looking for `tokio-trace` here find it in its new home. In addition, it changes `tokio` to depend on `tracing-core` rather than `tokio-trace-core`. Closes #1159 Signed-off-by: Eliza Weisman <eliza@buoyant.io>
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0a019e5f..6447d525 100644
--- a/README.md
+++ b/README.md
@@ -168,6 +168,23 @@ The crates included as part of Tokio are:
[`tokio-udp`]: tokio-udp
[`tokio-uds`]: tokio-uds
+## Related Projects
+
+In addition to the crates in this repository, the Tokio project also maintains
+several other libraries, including:
+
+* [`tracing`] (formerly `tokio-trace`): A framework for application-level
+ tracing and async-aware diagnostics.
+
+* [`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.
+
+[`tracing`]: https://github.com/tokio-rs/tracing
+[`mio`]: https://github.com/tokio-rs/mio
+[`bytes`]: https://github.com/tokio-rs/bytes
+
## Supported Rust Versions
Tokio is built against the latest stable, nightly, and beta Rust releases. The