mirror/async-std
2
0
Fork 1
mirror of https://github.com/async-rs/async-std.git synced 2025-01-30 01:05:31 +00:00
Code Issues Releases Wiki Activity

document feature flags

Browse source 
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
This commit is contained in:
Yoshua Wuyts 2019-09-16 14:54:19 +02:00
parent dc664786c9
commit 6e5f29fa58
No known key found for this signature in database
GPG key ID: 24EA8164F96777ED
2 changed files with 18 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -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:

19
src/lib.rs
View file

@ -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)]