From 96bbf7b89b160d0245c043a0bdc68a1a9efc18c9 Mon Sep 17 00:00:00 2001
From: Niko <niko@niko.lgbt>
Date: Wed, 13 Aug 2025 01:42:49 -0700
Subject: [PATCH] Add a quick entrypoint to the root docs

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

diff --git a/src/lib.rs b/src/lib.rs
index 3222b26..3f6d815 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,6 +1,11 @@
 #![allow(clippy::uninlined_format_args)]
 #![cfg_attr(test, feature(test))]
 
+//! Most users will be looking for nothing more than [`WhisperState::full`] to run a full transcription pipeline.
+//!
+//! You can get a [`WhisperState`] by first creating a [`WhisperContext`] using [`WhisperContext::new_with_params`],
+//! and then calling [`WhisperContext::create_state`].
+
 #[cfg(feature = "vulkan")]
 pub mod vulkan;