Include readme in package

Cargo.toml

@@ -8,6 +8,7 @@ exclude = ["Justfile", "_typos.toml", "notes.md", "scripts/", ".github/"]
 repository = "https://github.com/bash/mundy"
 keywords = ["accessibility", "contrast", "UI", "color", "accent"]
 categories = ["os", "gui"]
+readme = "readme.md"
 
 [dependencies]
 cfg-if = "1.0.0"

readme.md

@@ -15,6 +15,9 @@ The following preferences are supported:
 
 ## Example
 ```rust,no_run
+use mundy::{Preferences, Interest};
+use futures_util::StreamExt as _;
+
 // Interest tells mundy which preferences it should monitor for you.
 // use `Interest::All` if you're interested in all preferences.
 let mut stream = Preferences::stream(Interest::AccentColor);
@@ -23,7 +26,7 @@ async {
     while let Some(preferences) = stream.next().await {
         eprintln!("accent color: {:?}", preferences.accent_color);
     }
-}
+};
 ```
 
 ## [Docs](https://docs.rs/mundy)

src/lib.rs

@@ -80,6 +80,10 @@ mod stream_utils;
 #[cfg_attr(docsrs, doc(cfg(doc)))]
 pub mod feature_flags {}
 
+#[cfg(doctest)]
+#[doc = include_str!("../readme.md")]
+pub mod readme_doctest {}
+
 /// A collection of preferences retrieved by calling either
 /// [`Preferences::stream`] or [`Preferences::subscribe`].
 ///