diff --git a/README.md b/README.md index eb0160f..9290757 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,24 @@ fn main() { } ``` +## Features + +`async-std` is strongly commited to following semver. This means your code won't +break unless _you_ decide to upgrade. + +However every now and then we come up with something that we think will work +_great_ for `async-std`, and we want to provide a sneak-peek so you can try it +out. This is what we call _"unstable"_ features. You can try out the unstable +features by enabling the `unstable` feature in you `Cargo.toml` file: + +```toml +[dependencies] +async-std = { version = "0.99.5", features = ["unstable"] } +``` + +Just be careful when running these features, as they may change between +versions. + ## Take a look around Clone the repo: diff --git a/src/lib.rs b/src/lib.rs index ba12b2f..e5615b9 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -25,25 +25,6 @@ //! //! See [here](https://github.com/async-rs/async-std/tree/master/examples) //! for more examples. -//! -//! # Features -//! -//! `async-std` is strongly commited to following semver. This means your code -//! won't break unless _you_ decide to upgrade. -//! -//! However every now and then we come up with something that we think will -//! work _great_ for `async-std`, and we want to provide a sneak-peek so you -//! can try it out. This is what we call _"unstable"_ features. You can try out -//! the unstable features by enabling the `unstable` feature in you `Cargo.toml` -//! file: -//! -//! ```toml -//! [dependencies] -//! async-std = { version = "0.99.5", features = ["unstable"] } -//! ``` -//! -//! Just be careful when running these features, as they may change between -//! versions. #![cfg_attr(feature = "docs", feature(doc_cfg))] #![warn(missing_docs, missing_debug_implementations, rust_2018_idioms)]