add docs about feature flags
This commit is contained in:
parent
0907fbc474
commit
8c3fecb875
|
@ -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
|
## License
|
||||||
|
|
||||||
LGPL-3.0.
|
LGPL-3.0.
|
||||||
|
|
|
@ -29,6 +29,18 @@
|
||||||
//! Ok(())
|
//! 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 error;
|
||||||
pub mod stats;
|
pub mod stats;
|
||||||
|
|
Loading…
Reference in New Issue