From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Wed, 14 Dec 2022 22:15:05 +0000 (+0000)
Subject: Add lib.rs rustdoc stub documentation
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ian/git?a=commitdiff_plain;h=ab7ce67ad7d2c18c508bb9f4009ce20039607fa7;p=hippotat.git

Add lib.rs rustdoc stub documentation

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---

diff --git a/src/lib.rs b/src/lib.rs
index 16ef74f..06a3c08 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -2,6 +2,14 @@
 // SPDX-License-Identifier: GPL-3.0-or-later WITH LicenseRef-Hippotat-OpenSSL-Exception
 // There is NO WARRANTY.
 
+//! Library crate for Hippotat
+//!
+//! These libraries are for use within the Hippotat cargo package.
+//! They do not have a stable API.
+//!
+//! Please refer to the
+//! [project documentation](https://www.chiark.greenend.org.uk/~ianmdlvl/hippotat/current/docs/)
+
 pub mod prelude;
 
 pub mod config;