From 07b22697a270880ff3c84a28f54fd50a0c8d539a Mon Sep 17 00:00:00 2001
From: Rob Wagner <rob@sombia.com>
Date: Sat, 22 Jul 2023 18:56:14 -0400
Subject: [PATCH] Update documentation

---
 src/extractors.rs | 2 ++
 src/headers.rs    | 2 ++
 src/lib.rs        | 1 +
 3 files changed, 5 insertions(+)

diff --git a/src/extractors.rs b/src/extractors.rs
index a7adb09..576028f 100644
--- a/src/extractors.rs
+++ b/src/extractors.rs
@@ -1,3 +1,5 @@
+//! Axum extractors for htmx headers.
+
 use axum::{extract::FromRequestParts, http::request::Parts};
 
 use crate::{
diff --git a/src/headers.rs b/src/headers.rs
index e547141..34c5a7a 100644
--- a/src/headers.rs
+++ b/src/headers.rs
@@ -1,3 +1,5 @@
+//! HTTP headers used by htmx.
+
 /// Indicates that the request is via an element using `hx-boost` attribute.
 ///
 /// See <https://htmx.org/attributes/hx-boost/> for more information.
diff --git a/src/lib.rs b/src/lib.rs
index be3313e..9ea0b88 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,3 +1,4 @@
+#![doc = include_str!("../README.md")]
 #![forbid(unsafe_code)]
 pub mod extractors;
 pub mod headers;