forked from mirror/async-std
Add docs to feature section
This commit is contained in:
parent
6b0a81012b
commit
3c92ffeb5c
1 changed files with 12 additions and 0 deletions
12
src/lib.rs
12
src/lib.rs
|
@ -171,6 +171,18 @@
|
|||
//! features = ["attributes"]
|
||||
//! ```
|
||||
//!
|
||||
//! When the `serde` feature is enabled, it is possible to use `async_std` types such as [`path::PathBuf`]
|
||||
//! within types that are serialized or deserialized using [`serde`] compatible crates.
|
||||
//!
|
||||
//! [`serde`]: https://serde.rs
|
||||
//! [`path::PathBuf`]: path/struct.PathBuf.html
|
||||
//!
|
||||
//! ```toml
|
||||
//! [dependencies.async-std]
|
||||
//! version = "1.0.0"
|
||||
//! features = ["serde"]
|
||||
//! ```
|
||||
//!
|
||||
//! Additionally it's possible to only use the core traits and combinators by
|
||||
//! only enabling the `std` Cargo feature:
|
||||
//!
|
||||
|
|
Loading…
Reference in a new issue