docs: add module-level documentation and improve doc comments

1 files changed, 15 insertions, 1 deletions

diff --git a/mingling_picker/src/lib.rs b/mingling_picker/src/lib.rs
index afc7aca..ffa6e13 100644
--- a/mingling_picker/src/lib.rs
+++ b/mingling_picker/src/lib.rs
@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 mod builtin;
 
 mod picker;
@@ -12,16 +14,28 @@ pub use arg::*;
 mod infos;
 pub use infos::*;
 
+/// Provides the specific parsing logic for command-line arguments and common utilities,
+/// as well as customization of command-line argument styles.
 pub mod parselib;
 
+/// Parser-provided parseable command-line types
 pub mod value;
 
+/// The prelude module, which re-exports the most commonly used traits and types.
+///
+/// This module is intended to be imported with a wildcard import:
+///
+/// ```ignore
+/// use mingling_picker::prelude::*;
+/// ```
 pub mod prelude {
     pub use crate::IntoPicker;
+    pub use crate::macros::arg;
 }
 
+/// Re-export of the `mingling_picker_macros` crate
 pub mod macros {
-    pub use mingling_picker_macros::*;
+    pub use mingling_picker_macros::arg;
 }
 
 /// Provides the types necessary for implementing the `Pickable` trait