From 1986d31461d02716b7fea7667c65b983d93e33a9 Mon Sep 17 00:00:00 2001 From: glyph Date: Mon, 13 Dec 2021 11:00:16 +0200 Subject: [PATCH] feature flag docs and license --- peach-network/Cargo.toml | 2 +- peach-network/README.md | 14 ++++++++++++-- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/peach-network/Cargo.toml b/peach-network/Cargo.toml index 502a719..44987c7 100644 --- a/peach-network/Cargo.toml +++ b/peach-network/Cargo.toml @@ -7,7 +7,7 @@ description = "Query and configure network interfaces." homepage = "https://opencollective.com/peachcloud" repository = "ihttps://git.coopcloud.tech/PeachCloud/peach-workspace/src/branch/main/peach-network" readme = "README.md" -license = "AGPL-3.0-only" +license = "LGPL-3.0-only" publish = false [badges] diff --git a/peach-network/README.md b/peach-network/README.md index 2959f20..4b2ea7c 100644 --- a/peach-network/README.md +++ b/peach-network/README.md @@ -27,6 +27,16 @@ fn main() -> Result<(), NetworkError> { } ``` -## Licensing +## Feature Flags -AGPL-3.0 +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-network = { version = "0.3.0", features = ["miniserde_support"] } +``` + +## License + +LGPL-3.0.