add description to crate & README

Author: rursprung

Cargo.toml

@@ -3,6 +3,9 @@ name = "adafruit-bluefruit-protocol"
 version = "0.1.0"
 edition = "2021"
 
+description = "A `no_std` parser for the Adafruit Bluefruit LE Connect controller protocol."
+repository = "https://github.com/rursprung/adafruit-bluefruit-protocol-rs"
+keywords = ["adafruit", "bluefruit", "protocol", "bluetooth", "embedded", "driver", "no_std"]
 license = "MIT"
 
 [dependencies]

README.md

@@ -1,2 +1,10 @@
-# Adafruit Bluefruit LE UART Friend Rust Driver
-Currently written directly against the stm32f4xx-hal but hopefully this can be rewritten against the embedded-hal traits.
+# Adafruit Bluefruit LE Connect Controller Protocol Parser
+[![CI](https://github.com/rursprung/adafruit-bluefruit-protocol-rs/actions/workflows/CI.yml/badge.svg)](https://github.com/rursprung/adafruit-bluefruit-protocol-rs/actions/workflows/CI.yml)
+
+This implements the [Adafruit Bluefruit LE Connect controller protocol](https://learn.adafruit.com/bluefruit-le-connect/controller)
+which is e.g. used by the [Adafruit Bluefruit LE UART Friend](https://learn.adafruit.com/introducing-the-adafruit-bluefruit-le-uart-friend).
+
+Note that this work is not affiliated with Adafruit.
+
+## Optional features
+* `defmt`: you can enable the [`defmt`](https://defmt.ferrous-systems.com/) feature to get a `defmt::Format` implementation for all structs & enums and a `defmt::debug!` call for each command being parsed.

src/lib.rs

@@ -1,5 +1,8 @@
-//! Implements the [Controller Protocol](https://learn.adafruit.com/bluefruit-le-connect/controller) from Adafruit
+//! This implements the [Adafruit Bluefruit LE Connect controller protocol](https://learn.adafruit.com/bluefruit-le-connect/controller)
 //! which is e.g. used by the [Adafruit Bluefruit LE UART Friend](https://learn.adafruit.com/introducing-the-adafruit-bluefruit-le-uart-friend).
+//!
+//! ## Optional features
+//! * `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.
 
 #![forbid(unsafe_code)]
 // use deny instead of forbid due to bogus warnings, see also https://github.com/rust-lang/rust/issues/81670