Merge pull request #8 from alpenlabs/storopoli/docs/modules

doc: add module-level docs

src/hex.rs

@@ -1,3 +1,5 @@
+//! A module for encoding and decoding hexadecimal strings.
+
 use crate::err;
 use terrors::OneOf;
 
@@ -152,7 +154,7 @@ impl TryFrom<u8> for HexChar {
 impl From<HexChar> for u8 {
     /// Converts the character to its [`u8`] equivalent. Eg, 'a' becomes 10.
     ///
-    /// SAFETY: self is checked to be a valid hex character by [`HexChar`]'s
+    /// SAFETY: self is checked to be a valid hex character by `HexChar`'s
     /// [`TryFrom`] implementation.
     fn from(val: HexChar) -> Self {
         val.c as u8 - val.kind.offset()

src/macros.rs

@@ -1,3 +1,5 @@
+//! Macros for error handling.
+
 #[macro_export]
 macro_rules! err {
     ($item:expr) => {{

src/main.rs

@@ -1,3 +1,6 @@
+//! A simple faucet server that uses [`axum`] and [`bdk_wallet`]
+//! to generate and dispense bitcoin.
+
 pub mod hex;
 pub mod macros;