diff --git a/README.md b/README.md index 2e2d984..3a2d65f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [Documentation](https://cmr.github.io/evdev) -Nice access to `evdev`. +Nice(r) access to `evdev`. What is `evdev`? =================== @@ -16,16 +16,16 @@ What is `evdev`? What does this library support? =============================== -Device enumeration (by scanning), capability querying, event polling, -multitouch, and force feedback. Everything that `evdev` supports. +This library exposes raw evdev events, but uses the Rust `Iterator` trait to +do so, and will handle `SYN_DROPPED` events properly for the client. I try to +match [libevdev](http://www.freedesktop.org/software/libevdev/doc/latest/) +closely, where possible. + +Writing to devices is not yet supported (eg, turning LEDs on). Example ======= -```rust -extern crate evdev; - -fn main() { - // fixme -} -``` +See for an example of using this library (which roughly +corresponds to the userspace [evtest](http://cgit.freedesktop.org/evtest/) +tool. diff --git a/examples/evtest.rs b/examples/evtest.rs index 5452ce6..e458367 100644 --- a/examples/evtest.rs +++ b/examples/evtest.rs @@ -23,7 +23,7 @@ fn main() { println!("{}", d); println!("Events:"); loop { - for ev in d.raw_events() { + for ev in d.events_no_sync().unwrap() { println!("{:?}", ev); } }