From cb96987115e560878c700beea421c2adfa49d0e2 Mon Sep 17 00:00:00 2001
From: Joscha <joscha@plugh.de>
Date: Sun, 8 Dec 2024 00:19:51 +0100
Subject: [PATCH] Tweak readme and lib docs

---
 README.md  | 12 ++++++++----
 src/lib.rs |  4 ++++
 2 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index a5d12f4..d4bd029 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
 # el
 
-`el` is a Rust library for writing, modifying, and safely rendering HTML
-elements as simple data structures. It is inspired by [hiccup] and named after a
-small helper function I once wrote in JS.
+`el` is a no-dependencies Rust library for writing, modifying, and safely
+rendering HTML elements as simple data structures. It is inspired by [hiccup]
+and named after a small helper function I once wrote in JS.
 
 [hiccup]: https://github.com/weavejester/hiccup
 
-## Usage example
+## Show me a simple example
 
 ```rs
 use el::{Attr, Render, html::*};
@@ -30,6 +30,10 @@ let page: String = html((
 .unwrap();
 ```
 
+## What now?
+
+See the top-level crate documentation for more info.
+
 ## But what about that small helper function?
 
 Here it is in full, for posteriority:
diff --git a/src/lib.rs b/src/lib.rs
index fd4bc9e..62ceca5 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -67,6 +67,10 @@
 //! ```
 //!
 //! [axum]: https://crates.io/crates/axum
+//!
+//! ## But what about that small helper function?
+//!
+//! See the readme for more details.
 
 #[cfg(feature = "axum")]
 mod axum;