From 95ad3e91fffa081812eb0ad49101a8e3f7b1dc08 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fe=CC=81lix=20Saparelli?= <felix@passcod.name>
Date: Fri, 20 Aug 2021 02:56:13 +1200
Subject: [PATCH] Add example / aspirational usage to lib doc

---
 lib/src/config.rs |  3 +--
 lib/src/lib.rs    | 31 ++++++++++++++++++++++++++++++-
 2 files changed, 31 insertions(+), 3 deletions(-)

diff --git a/lib/src/config.rs b/lib/src/config.rs
index 2a0ddf8..250f36c 100644
--- a/lib/src/config.rs
+++ b/lib/src/config.rs
@@ -5,11 +5,10 @@ use derive_builder::Builder;
 /// This is used both for constructing the instance and to reconfigure it at runtime, though note
 /// that some fields are only applied at construction time.
 ///
-/// You should prefer the [`ConfigBuilder`] rather than using this directly. This struct is marked
+/// Use [`ConfigBuilder`] to build a new one, or modify an existing one. This struct is marked
 /// non-exhaustive such that new options may be added without breaking change.
 #[derive(Builder, Clone, Debug)]
 #[non_exhaustive]
-#[builder(build_fn(name = "finish"))]
 pub struct Config {
 	/// Working data for the filesystem event source.
 	///
diff --git a/lib/src/lib.rs b/lib/src/lib.rs
index eec7a7c..84a6d0b 100644
--- a/lib/src/lib.rs
+++ b/lib/src/lib.rs
@@ -10,6 +10,35 @@
 //! running it. The config may contain some instances of [`Handler`]s, which hook into watchexec
 //! processing at various points.
 //!
+//! ```no_compile // TODO: implement and switch to no_run
+//! use watchexec::{Watchexec, ConfigBuilder, Handler as _};
+//!
+//! #[tokio::main]
+//! async fn main() {
+//!     let mut config = ConfigBuilder::new()
+//!     config.pathset(["watchexec.conf"]);
+//!
+//!     let conf = YourConfigFormat::load_from_file("watchexec.conf").await?;
+//!     conf.apply(&mut config);
+//!
+//!     let we = Watchexec::new(config.build().unwrap()).unwrap();
+//!     let w = we.clone();
+//!
+//!     let c = config.clone();
+//!     config.on_event(|e| async move {
+//!         if e.path().map(|p| p.ends_with("watchexec.conf")).unwrap_or(false) {
+//!             let conf = YourConfigFormat::load_from_file("watchexec.conf").await?;
+//!
+//!             conf.apply(&mut config);
+//!             w.reconfigure(config.build());
+//!             // tada! self-reconfiguring watchexec on config file change!
+//!         }
+//!     });
+//!
+//!     w.main().await.unwrap();
+//! }
+//! ```
+//!
 //! Alternatively, one can use the modules exposed by the crate and the external crates such as
 //! [ClearScreen][clearscreen] and [Command Group][command_group] to build something more advanced,
 //! at the cost of reimplementing the glue code. See the examples folder for some basic/demo tools
@@ -36,7 +65,7 @@ mod handler;
 mod watchexec;
 
 #[doc(inline)]
-pub use config::Config;
+pub use config::{Config, ConfigBuilder};
 #[doc(inline)]
 pub use handler::Handler;
 #[doc(inline)]