Skip to content

Commit 9271f56

Browse files
committed
Bump version to 0.4 and update the readme
Signed-off-by: Paul Osborne <[email protected]>
1 parent 97c14ef commit 9271f56

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
name = "i2cdev"
44
build = "build.rs"
5-
version = "0.3.2"
5+
version = "0.4.0"
66
authors = ["Paul Osborne <[email protected]>"]
77
license = "MIT/Apache-2.0"
88
repository = "https://github.com/rust-embedded/rust-i2cdev"

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ low-level system calls. The documentation for the i2cdev interace can
1313
be found at https://www.kernel.org/doc/Documentation/i2c/dev-interface and
1414
in the [lm-sensors projects](http://www.lm-sensors.org/).
1515

16+
Device driver developers should consider building on top of the
17+
[embedded-hal](https://crates.io/crates/embedded-hal) traits rather than
18+
directly coupling to this library. An implementation of those generic traits for
19+
Linux can be found in
20+
[linux-embedded-hal](https://crates.io/crates/linux-embedded-hal) which, at
21+
present, uses this crate as the backend for I2C.
22+
1623
Example/API
1724
-----------
1825

@@ -21,10 +28,7 @@ Nunchuck (which has an i2c interface).
2128
[Go View the Example](https://github.com/rust-embedded/rust-i2cdev/blob/master/examples/nunchuck.rs).
2229

2330
Here's a real quick example showing the guts of how you create
24-
device and start talking to it... This device only requires basic
25-
functions (read/write) which are done via the Read/Write traits (if
26-
you actually want to use the Wii Nunchuck you should use
27-
[`i2cdev::sensors::nunchuck::Nunchuck`][nunchuck]:
31+
device and start talking to it...
2832

2933
```rust,no_run,skeptic-template
3034
extern crate i2cdev;
@@ -59,8 +63,6 @@ fn i2cfun() -> Result<(), LinuxI2CError> {
5963
In addition to the Read/Write traits, the following methods are
6064
available via the [I2CDevice trait](https://rust-embedded.github.io/rust-i2cdev/i2cdev/core/trait.I2CDevice.html).
6165

62-
[nunchuck]: http://rust-embedded.github.io/rust-i2cdev/i2cdev/sensors/nunchuck/struct.Nunchuck.html
63-
6466
Features
6567
--------
6668

0 commit comments

Comments
 (0)