From fc57d8583a578df9565d3143108504b1a21fd1b7 Mon Sep 17 00:00:00 2001 From: diogo464 Date: Tue, 9 Dec 2025 22:21:44 +0000 Subject: added some documentation --- src/lib.rs | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 672fde9..3e91272 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,16 @@ +//! Home Assistant MQTT device library for embassy. +//! +//! To create a device use the [`new`] function. +//! After the device is created you should create one or more entities using functions such as +//! [`create_button`]/[`create_sensor`]/... +//! +//! Once the entities have been created either [`run`] or [`connect_and_run`] should be called in a +//! seperate task. +//! +//! There are various examples you can run locally (ex: `cargo run --features tracing --example +//! button`) assuming you have a home assistant instance running. To run the examples the +//! environment variable `MQTT_ADDRESS` should be set to the mqtt server used by home assistant. + #![no_std] use core::{ -- cgit