add readme for examples and more example comments

examples/README.md

@@ -0,0 +1,20 @@
+Examples for notify and the debouncers.
+
+### Notify
+
+- **minitor_raw** basic example for using notify
+- **async_monitor** example for using `futures::channel` to receive events in async code
+- **poll_sysfs** example for observing linux `/sys` events using PollWatcher and the hasing mode
+- **watcher_kind** example for detecting the kind of watcher used and running specific configurations
+- **hot_reload_tide** large example for async notify using the crates tide and async-std
+- **pollwatcher_scan** example using `PollWatcher::with_initial_scan` to listen for files found during initial scanning
+
+### Notify Debouncer Full (debouncer)
+
+- **monitor_debounced** basic usage example for the debouncer
+- **monitor_full** advanced usage accessing the internal file ID cache
+
+### Debouncer Mini (mini debouncer)
+
+- **debouncer_mini** basic usage example for the mini debouncer
+- **debouncer_mini_custom** using the mini debouncer with a specific backend (PollWatcher)

examples/debouncer_full.rs

@@ -4,6 +4,7 @@ use notify::{RecursiveMode, Watcher};
 use notify_debouncer_full::new_debouncer;
 use tempfile::tempdir;
 
+/// Advanced example of the notify-debouncer-full, accessing the internal file ID cache
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     let dir = tempdir()?;
     let dir_path = dir.path().to_path_buf();

examples/monitor_debounced.rs

@@ -2,6 +2,7 @@ use notify::{RecursiveMode, Watcher};
 use notify_debouncer_full::new_debouncer;
 use std::{path::Path, time::Duration};
 
+/// Example for notify-debouncer-full
 fn main() {
     env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init();