From ba20217b63a1294994321bcec063d382b9d06e69 Mon Sep 17 00:00:00 2001
From: Ilya Epifanov <elijah.epifanov@gmail.com>
Date: Mon, 19 Mar 2018 13:39:11 +0100
Subject: [PATCH] updated docs

---
 README.md  |  4 ++++
 src/lib.rs | 16 +++++++++++++++-
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 69ac35d..e40eb02 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,10 @@
 [![crates.io](https://img.shields.io/crates/v/si5351.svg)](https://crates.io/crates/si5351)
 [![ci](https://travis-ci.org/ilya-epifanov/si5351.svg)](https://travis-ci.org/ilya-epifanov/si5351)
 
+## Documentation
+
+On [docs.rs](https://docs.rs/si5351)
+
 ## License
 
 Licensed under either of
diff --git a/src/lib.rs b/src/lib.rs
index 2eeb125..ad3feb6 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -46,11 +46,24 @@ use si5351;
 use si5351::{Si5351, Si5351Device};
 
 # fn main() {
-let mut clock = Si5351Device<'static, I2C>::new(i2c, false, 25_000_000);
+let mut clock = Si5351Device<I2C>::new(&mut i2c, false, 25_000_000);
 clock.init(si5351::CrystalLoad::_10)?;
 # }
 ```
 
+Or, if you have an [Adafruit module], you can use shortcut functions to initializate it:
+```no_run
+# extern crate stm32f103xx_hal as hal;
+# extern crate si5351;
+use si5351;
+use si5351::{Si5351, Si5351Device};
+
+# fn main() {
+let mut clock = Si5351Device<I2C>::new_adafruit_module(&mut i2c);
+clock.init_adafruit_module()?;
+# }
+```
+
 And set frequency on one of the outputs:
 
 ```no_run
@@ -61,6 +74,7 @@ clock.set_frequency(si5351::PLL::A, si5351::ClockOutput::Clk0, 14_175_000)?;
 
 [Si5351]: https://www.silabs.com/documents/public/data-sheets/Si5351-B.pdf
 [`embedded-hal`]: https://github.com/japaric/embedded-hal
+[Adafruit module]: https://www.adafruit.com/product/2045
 */
 //#![deny(missing_docs)]
 #![deny(warnings)]