diff --git a/src/lib.rs b/src/lib.rs index 95551e0..e7a4b68 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,6 +1,7 @@ //! This is a platform agnostic Rust driver for the LSM303AGR ultra-compact //! high-performance eCompass module: ultra-low-power 3D accelerometer and //! 3D magnetometer using the [`embedded-hal`] traits. +//! This driver also supports the [`embedded-hal-async`] traits if the `async` feature is enabled. //! //! [`embedded-hal`]: https://github.com/rust-embedded/embedded-hal //! @@ -100,6 +101,9 @@ //! } //! # } //! ``` +//! +//! For an example of using the async support of this driver on a micro:bit V2, +//! have a look at [microbit-v2 example](https://github.com/eldruin/lsm303agr-rs/blob/master/examples/microbit-v2.rs) #![deny(unsafe_code, missing_docs)] #![allow(async_fn_in_trait)]