Merge pull request #59 from quartiq/feature/release-chores

v0.2 release chores

CHANGELOG.md

@@ -5,19 +5,24 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-* Added support for generic maximum MQTT message size
-* `derive_miniconf` added support for generic types
 
 ### Added
+### Changed
+### Removed
+
+## [0.1.0] - 2021-10-28
+
+### Added
+* Added support for generic maximum MQTT message size
+* `derive_miniconf` added support for generic types
 
 ### Changed
 * Updated minimq dependency to support ping TCP reconnection support
 
-### Removed
-
 ## [0.1.0] - 2021-08-11
 
 Library initially released on crates.io
 
-[Unreleased]: https://github.com/quartiq/miniconf/compare/v0.1.0...HEAD
+[Unreleased]: https://github.com/quartiq/miniconf/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/quartiq/miniconf/releases/tag/v0.2.0
 [0.1.0]: https://github.com/quartiq/miniconf/releases/tag/v0.1.0

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "miniconf"
-version = "0.1.0"
+version = "0.2.0"
 authors = ["James Irwin <[email protected]>", "Ryan Summers <[email protected]"]
 edition = "2018"
 license = "MIT"

derive_miniconf/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "derive_miniconf"
-version = "0.1.0"
+version = "0.1.1"
 authors = ["James Irwin <[email protected]>", "Ryan Summers <[email protected]"]
 edition = "2018"
 license = "MIT"

src/lib.rs

@@ -8,6 +8,10 @@
 //! Miniconf uses a [Derive macro](derive.Miniconf.html) to automatically assign unique paths to
 //! each setting. All values are transmitted and received in JSON format.
 //!
+//! ## Features
+//! Miniconf supports an MQTT-based client for configuring and managing run-time settings via MQTT.
+//! To enable this feature, enable the `mqtt-client` feature.
+//!
 //! ## Supported Protocols
 //!
 //! Miniconf is designed to be protocol-agnostic. Any means that you have of receiving input from
@@ -27,26 +31,24 @@
 //!     backward: f32,
 //! }
 //!
-//! #[derive(Deserialize, Miniconf, Default)]
+//! #[derive(Miniconf, Default)]
 //! struct Settings {
 //!     filter: Coefficients,
 //!     channel_gain: [f32; 2],
 //!     sample_rate: u32,
 //!     force_update: bool,
 //! }
 //!
-//! fn main() {
-//!     let mut settings = Settings::default();
+//! let mut settings = Settings::default();
 //!
-//!     // Update sample rate.
-//!     miniconf::update(&mut settings, "sample_rate", b"350").unwrap();
+//! // Update sample rate.
+//! miniconf::update(&mut settings, "sample_rate", b"350").unwrap();
 //!
-//!     // Update filter coefficients.
-//!     miniconf::update(&mut settings, "filter", b"{\"forward\": 35.6, \"backward\": 0.0}").unwrap();
+//! // Update filter coefficients.
+//! miniconf::update(&mut settings, "filter", b"{\"forward\": 35.6, \"backward\": 0.0}").unwrap();
 //!
-//!     // Update channel gain for channel 0.
-//!     miniconf::update(&mut settings, "channel_gain/0", b"15").unwrap();
-//! }
+//! // Update channel gain for channel 0.
+//! miniconf::update(&mut settings, "channel_gain/0", b"15").unwrap();
 //! ```
 //!
 //! ## Limitations
@@ -67,7 +69,9 @@ pub use minimq;
 #[cfg(feature = "mqtt-client")]
 pub use minimq::embedded_time;
 
+#[doc(hidden)]
 pub use serde::de::{Deserialize, DeserializeOwned};
+
 pub use serde_json_core;
 
 pub use derive_miniconf::{Miniconf, MiniconfAtomic};