From ea227f86c66a88f97267159cc44e4cef3ca00ffd Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Thu, 7 Dec 2023 16:00:43 +0000 Subject: [PATCH] Add crate-level documentation --- src/lib.rs | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 7c2864e..dc27629 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,13 @@ +//! This crate provides low-level types for implementing Zcash specifications. When a +//! common function defined in [the Zcash Protocol Specification] is used in multiple +//! protocols (for example the Sapling and Orchard shielded protocols), a corresponding +//! common type in this crate can be shared between implementations (for example by the +//! [`sapling-crypto`] and [`orchard`] crates). +//! +//! [the Zcash Protocol Specification]: https://zips.z.cash/protocol/protocol.pdf +//! [`sapling-crypto`]: https://crates.io/crates/sapling-crypto +//! [`orchard`]: https://crates.io/crates/orchard + #![deny(rustdoc::broken_intra_doc_links)] mod prf_expand;