From 39c432134c208960ff8616215c090966e2971f17 Mon Sep 17 00:00:00 2001 From: marcelbuesing Date: Fri, 25 May 2018 23:05:18 +0200 Subject: [PATCH] Add crate description --- src/lib.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index daa68f8..97eeb8e 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,9 @@ +//! This crate is a pure Rust implementation for the BME680 environmental sensor. +//! The library can be used to read the gas, pressure, humidity and temperature sensors via I²C. +//! +//! The library uses the embedded-hal crate to abstract reading and writing via I²C. +//! In the examples you can find a demo how to use the library in Linux using the linux-embedded-hal crate (e.g. on a RPI). + #![no_std] #[macro_use]