Skip to content

Commit a7ec442

Browse files
committed
document that parse is the entry point to be used
1 parent 29cca90 commit a7ec442

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ If you select neither or both you'll get a compile error.
2323
but you can opt to only select the event(s) you are interested in which will result in a small binary size.
2424
If other events are received, a `ProtocolParseError::DisabledControllerDataPackageType` will be returned.
2525

26+
## Usage
27+
The entry point to use this crate is the `parse` function.
28+
2629
## Examples
2730
A simple example for the STM32F4 microcontrollers is [available](examples/stm32f4-event-printer/README.md).
2831

src/lib.rs

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
//! This implements the [Adafruit Bluefruit LE Connect controller protocol](https://learn.adafruit.com/bluefruit-le-connect/controller)
22
//! which is e.g. used by the [Adafruit Bluefruit LE UART Friend](https://learn.adafruit.com/introducing-the-adafruit-bluefruit-le-uart-friend).
33
//!
4+
//! The entry point to use this crate is the [`parse`] function.
5+
//!
46
//! ## Optional features
57
//! * `defmt`: you can enable the `defmt` feature to get a `defmt::Format` implementation for all structs & enums and a `defmt::debug!` call for each command being parsed.
68
//! * `rgb`: if enabled, `From<ColorEvent> for RGB8` is implemented to support the [RGB crate](https://crates.io/crates/rgb).

0 commit comments

Comments
 (0)