v0.1.0

Author: japaric

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## v0.1.0 - 2018-01-17
+
+Initial release
+
+[Unreleased]: https://github.com/japaric/linux-embedded-hal/compare/v0.1.0...HEAD

Cargo.toml

@@ -1,6 +1,11 @@
 [package]
 authors = ["Jorge Aparicio <[email protected]>"]
+categories = ["embedded", "hardware-support"]
+description = "Implementation of the `embedded-hal` traits for Linux devices"
+keywords = ["Linux", "hal"]
+license = "MIT OR Apache-2.0"
 name = "linux-embedded-hal"
+repository = "https://github.com/japaric/linux-embedded-hal"
 version = "0.1.0"
 
 [dependencies]

README.md

@@ -1,6 +1,6 @@
 # `linux-embedded-hal`
 
-> Implementation of [`embedded-hal`] traits for Linux devices
+> Implementation of the [`embedded-hal`] traits for Linux devices
 
 [`embedded-hal`]: https://crates.io/crates/embedded-hal
 

src/lib.rs

@@ -1,6 +1,14 @@
 //! Implementation of [`embedded-hal`] traits for Linux devices
 //!
 //! [`embedded-hal`]: https://docs.rs/embedded-hal
+//!
+//! # Drivers
+//!
+//! This crate lets you use a bunch of platform agnostic drivers that are based on the
+//! `embedded-hal` traits. You can find them on crates.io by [searching for the embedded-hal
+//! keyword][0].
+//!
+//! [0]: https://crates.io/keywords/embedded-hal
 
 #![deny(missing_docs)]
 #![deny(warnings)]
@@ -21,14 +29,14 @@ use spidev::SpidevTransfer;
 pub struct Pin(pub sysfs_gpio::Pin);
 
 impl Pin {
-    /// See [`sysfs_gpio::Pin::new`][0]
+    /// See [`sysfs_gpio::Pin::new`][0] for details.
     ///
     /// [0]: https://docs.rs/sysfs_gpio/0.5.1/sysfs_gpio/struct.Pin.html#method.new
     pub fn new(pin_num: u64) -> Pin {
         Pin(sysfs_gpio::Pin::new(pin_num))
     }
 
-    /// See [`sysfs_gpio::Pin::from_path`][0]
+    /// See [`sysfs_gpio::Pin::from_path`][0] for details.
     ///
     /// [0]: https://docs.rs/sysfs_gpio/0.5.1/sysfs_gpio/struct.Pin.html#method.from_path
     pub fn from_path<P>(path: P) -> sysfs_gpio::Result<Pin>
@@ -77,7 +85,7 @@ impl ops::DerefMut for Pin {
 pub struct Spidev(pub spidev::Spidev);
 
 impl Spidev {
-    /// See [`spidev::Spidev::open`][0]
+    /// See [`spidev::Spidev::open`][0] for details.
     ///
     /// [0]: https://docs.rs/spidev/0.3.0/spidev/struct.Spidev.html#method.open
     pub fn open<P>(path: P) -> io::Result<Self>