diff --git a/peach-stats/README.md b/peach-stats/README.md index 198c593..5a981be 100644 --- a/peach-stats/README.md +++ b/peach-stats/README.md @@ -32,6 +32,16 @@ fn main() -> Result<(), StatsError> { } ``` +## Feature Flags + +Feature flags are used to offer `Serialize` and `Deserialize` implementations for all `struct` data types provided by this library. These traits are not provided by default. A choice of `miniserde` and `serde` is provided. + +Define the desired feature in the `Cargo.toml` manifest of your project: + +```toml +peach-stats = { version = "0.1.0", features = ["miniserde_support"] } +``` + ## License LGPL-3.0. diff --git a/peach-stats/src/lib.rs b/peach-stats/src/lib.rs index e69ad27..b48cc31 100644 --- a/peach-stats/src/lib.rs +++ b/peach-stats/src/lib.rs @@ -29,6 +29,18 @@ //! Ok(()) //! } //! ``` +//! +//! ## Feature Flags +//! +//! Feature flags are used to offer `Serialize` and `Deserialize` implementations +//! for all `struct` data types provided by this library. These traits are not +//! provided by default. A choice of `miniserde` and `serde` is provided. +//! +//! Define the desired feature in the `Cargo.toml` manifest of your project: +//! +//! ```toml +//! peach-stats = { version = "0.1.0", features = ["miniserde_support"] } +//! ``` pub mod error; pub mod stats;