feature flag docs and license

This commit is contained in:
glyph 2021-12-13 11:00:16 +02:00
parent a824be53b9
commit 1986d31461
2 changed files with 13 additions and 3 deletions

View File

@ -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]

View File

@ -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.