From 6d1f28eb79c6c70b058fcbae5047dbd744764149 Mon Sep 17 00:00:00 2001
From: cel 🌸 <cel@bunny.garden>
Date: Fri, 30 May 2025 13:29:02 +0100
Subject: doc: everything

---
 src/lib.rs | 31 ++++++++++++++++++++++++++-----
 1 file changed, 26 insertions(+), 5 deletions(-)

(limited to 'src/lib.rs')

diff --git a/src/lib.rs b/src/lib.rs
index 8d95d0b..b534d08 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,18 +1,39 @@
+//! # peanuts: An ergonomic (async) xml reader/writer library.
+//!
+//! Features:
+//!
+//! - Serialisation
+//! - Deserialisation
+//! - DOM navigation
+//! - Namespacing
+//! - Websocket framing
+
+/// XML prolog declaration types.
 pub mod declaration;
-pub mod element;
-mod endable;
+mod element;
 mod error;
-pub mod loggable;
-pub mod reader;
+mod reader;
 mod writer;
-pub mod xml;
+// TODO: alternative raw xml API
+mod xml;
 
+/// Result type for the crate.
 pub type Result<T> = std::result::Result<T, error::Error>;
 
+/// XML namespace URI for the `xml:` namespace prefix.
 pub const XML_NS: &str = "http://www.w3.org/XML/1998/namespace";
+/// XML namespace URI for the `xmlns:` namespace prefix.
 pub const XMLNS_NS: &str = "http://www.w3.org/2000/xmlns/";
 
+pub use element::Content;
+pub use element::ContentBuilder;
+pub use element::DeserializeResult;
 pub use element::Element;
+pub use element::ElementBuilder;
+pub use element::FromContent;
+pub use element::FromElement;
+pub use element::IntoContent;
+pub use element::IntoElement;
 pub use error::DeserializeError;
 pub use error::Error;
 pub use reader::Reader;
-- 
cgit