Add back docs from old blobs

Author: rklaehn

src/lib.rs

@@ -1,3 +1,26 @@
+//! Blobs layer for iroh.
+//!
+//! The crate is designed to be used from the [iroh] crate.
+//!
+//! It implements a [protocol] for streaming content-addressed data transfer using
+//! [BLAKE3] verified streaming.
+//!
+//! It also provides a [store] module for storage of blobs and outboards,
+//! as well as a [persistent](crate::store::fs) and a [memory](crate::store::mem)
+//! store implementation.
+//!
+//! To implement a server, the [provider] module provides helpers for handling
+//! connections and individual requests given a store.
+//!
+//! To perform get requests, the [get] module provides utilities to perform
+//! requests and store the result in a store, as well as a low level state
+//! machine for executing requests.
+//!
+//! The [api::downloader] module provides a component to download blobs from
+//! multiple sources and store them in a store.
+//!
+//! [BLAKE3]: https://github.com/BLAKE3-team/BLAKE3-specs/blob/master/blake3.pdf
+//! [iroh]: https://docs.rs/iroh
 mod hash;
 pub mod store;
 pub use hash::{BlobFormat, Hash, HashAndFormat};
@@ -11,11 +34,13 @@ mod net_protocol;
 pub use net_protocol::BlobsProtocol;
 pub mod protocol;
 pub mod provider;
-pub mod test;
 pub mod ticket;
 pub(crate) mod util;
 
 #[cfg(test)]
 mod tests;
 
+#[doc(hidden)]
+pub mod test;
+
 pub use protocol::ALPN;