read and license

README.md

@@ -0,0 +1,36 @@
+# mitemp.rs
+
+Read Xiaomi MI Temperature and Humidity Sensor over BLE
+
+## Usafe
+
+```rust
+use btleplug::api::BDAddr;
+use mitemp::{adapter_by_mac, listen};
+use std::str::FromStr;
+
+fn main() -> Result<(), btleplug::Error> {
+    let addr = BDAddr::from_str("00:1A:7D:DA:71:08").unwrap();
+    let adapter = adapter_by_mac(addr)?;
+    let device = BDAddr::from_str("58:2d:34:35:f3:d4").unwrap();
+
+    let rx = listen(adapter, device);
+    loop {
+        let data = rx.recv().unwrap();
+        dbg!(data);
+    }
+}
+```
+
+## License
+
+Licensed under either of
+ * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you shall be dual licensed as above, without any
+additional terms or conditions.