Skip to content

Commit dd92d8d

Browse files
Merge #202
202: Document feature flags in readme r=yoshuawuyts a=yoshuawuyts Follow up to #190, this documents our feature flags in our readme. Thanks! Co-authored-by: Yoshua Wuyts <[email protected]> Co-authored-by: Yoshua Wuyts <[email protected]>
2 parents ee31f68 + 8058d63 commit dd92d8d

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,26 @@ fn main() {
8181
}
8282
```
8383

84+
## Features
85+
86+
`async-std` is strongly commited to following semver. This means your code won't
87+
break unless _you_ decide to upgrade.
88+
89+
However every now and then we come up with something that we think will work
90+
_great_ for `async-std`, and we want to provide a sneak-peek so you can try it
91+
out. This is what we call _"unstable"_ features. You can try out the unstable
92+
features by enabling the `unstable` feature in your `Cargo.toml` file:
93+
94+
```toml
95+
[dependencies]
96+
[dependencies.async-std]
97+
version = "0.99"
98+
features = ["unstable"]
99+
```
100+
101+
Just be careful when using these features, as they may change between
102+
versions.
103+
84104
## Take a look around
85105

86106
Clone the repo:

0 commit comments

Comments
 (0)