Merge remote-tracking branch 'origin/main' into simplified-api

CHANGELOG.md

@@ -22,6 +22,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Improved documentation
 - Made library easier to use
 
+## [v0.1.1]
+
+- Added badges and some documentation and README tweaks
+
 ## [v0.1.0]
 
 - Initial release

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "max116xx-10bit"
-version = "0.1.0"
+version = "0.1.1"
 authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
 edition = "2021"
 description = "Driver crate for the MAX116xx 10-bit ADC devices"

README.md

@@ -1,3 +1,7 @@
+[![Crates.io](https://img.shields.io/crates/v/max116xx-10bit)](https://crates.io/crates/max116xx-10bit)
+[![build](https://github.com/us-irs/max116xx-10bit-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/us-irs/max116xx-10bit-rs/actions/workflows/ci.yml)
+[![docs.rs](https://img.shields.io/docsrs/max116xx-10bit)](https://docs.rs/max116xx-10bit)
+
 Rust Maxim 116xx 10-bit ADC device driver crate
 ========
 
@@ -22,4 +26,5 @@ The crate uses basic type-level support to prevent using the ADC in a wrong way.
 The type-level support defaults to an externally clocked device with no wake-up delay.
 
 This crate was tested using the Vorago REB1 development board. You can find an example application
-[here](https://egit.irs.uni-stuttgart.de/rust/vorago-reb1).
+[here](https://egit.irs.uni-stuttgart.de/rust/vorago-reb1/src/branch/main/src/max11619.rs)
+and [here](https://egit.irs.uni-stuttgart.de/rust/vorago-reb1/src/branch/main/examples/max11619-adc.rs).

src/lib.rs

@@ -15,6 +15,11 @@
 //!  - [`Max116xx10Bit::into_ext_clkd_with_int_ref_wakeup_delay`]
 //!  - [`Max116xx10Bit::into_int_clkd_int_timed_through_ser_if_with_wakeup`]
 //!  - [`Max116xx10Bit::into_int_clkd_int_timed_through_ser_if_without_wakeup`]
+//!
+//! ## Examples
+//!
+//! You can find an example application [here](https://egit.irs.uni-stuttgart.de/rust/vorago-reb1/src/branch/main/examples/max11619-adc.rs)
+//! using a [thin abstraction layer](https://egit.irs.uni-stuttgart.de/rust/vorago-reb1/src/branch/main/src/max11619.rs)
 #![no_std]
 use core::{marker::PhantomData, slice::IterMut};
 use embedded_hal::{