Merge pull request #38 from mon/more-changes

Fix some IfChangeNotifier docs

Author: messense

README.md

@@ -3,7 +3,7 @@ https://crates.io/crates/if-addrs
 
 ## Overview
 
-Retrieve network interface info for all interfaces on the system.
+Retrieve network interface info for all interfaces on the system:
 
 ```rust
 // List all of the machine's network interfaces
@@ -12,9 +12,16 @@ for iface in if_addrs::get_if_addrs().unwrap() {
 }
 ```
 
-## Todo Items
+Get notifications for changes in network interfaces:
 
-  * Create an API for responding to changes in network interfaces.
+```rust
+let mut notifier = if_addrs::IfChangeNotifier::new().unwrap();
+loop {
+    if let Ok(details) = notifier.wait(None) {
+        println!("{:#?}", details);
+    }
+}
+```
 
 ## License
 

src/lib.rs

@@ -413,9 +413,8 @@ mod if_change_notifier {
     }
 
     impl IfChangeNotifier {
-        /// Create a new interface change notifier Returns an
-        /// [`io::ErrorKind::WouldBlock`] error if the network notifier could
-        /// not be set up.
+        /// Create a new interface change notifier. Returns an OS specific error
+        /// if the network notifier could not be set up.
         pub fn new() -> io::Result<Self> {
             Ok(Self {
                 inner: InternalIfChangeNotifier::new()?,