Merge pull request #11 from eldruin/add-docs

Add readme and some basic documentation

README.md

@@ -0,0 +1,29 @@
+# `embedded-hal` traits implementation by bit banging
+
+[![crates.io](https://img.shields.io/crates/v/bitbang-hal.svg)](https://crates.io/crates/bitbang-hal)
+[![Docs](https://docs.rs/bitbang-hal/badge.svg)](https://docs.rs/bitbang-hal)
+
+This is a [bit banging] implementation of the [`embedded-hal`] traits.
+
+[bit banging]: https://en.wikipedia.org/wiki/Bit_banging
+[`embedded-hal`]: https://github.com/rust-embedded/embedded-hal
+
+## Usage
+
+See example programs in the `examples` folder.
+
+## Support
+
+For questions, issues, feature requests, and other changes, please file an
+issue in the github project.
+
+## License
+
+Licensed under MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+### Contributing
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you shall be licensed as above, without any
+additional terms or conditions.
+

src/lib.rs

@@ -1,5 +1,14 @@
+//! This is a [bit banging] implementation of the [`embedded-hal`] traits.
+//!
+//! [bit banging]: https://en.wikipedia.org/wiki/Bit_banging
+//! [`embedded-hal`]: https://github.com/rust-embedded/embedded-hal
+//!
+//! ## Usage examples
+//!
+//! See usage examples in the examples folder in the crate sources
+
 #![no_std]
 
 pub mod i2c;
-pub mod spi;
 pub mod serial;
+pub mod spi;

src/serial.rs

@@ -1,3 +1,5 @@
+//! Serial communication (USART)
+
 use embedded_hal::digital::v2::{OutputPin, InputPin};
 use embedded_hal::timer::{CountDown, Periodic};
 use embedded_hal::serial;

src/spi.rs

@@ -1,3 +1,5 @@
+//! Serial Peripheral Interface
+
 pub use embedded_hal::spi::{MODE_0, MODE_1, MODE_2, MODE_3};
 
 use embedded_hal::digital::v2::{InputPin, OutputPin};