Update the example in the readme.

Also add a missing Deref so you can use BlobsProtocol as a Store directly.

Author: rklaehn

README.md

@@ -22,6 +22,7 @@ This crate is used together with [iroh](https://crates.io/crates/iroh). Connecti
 
 - **Requester:** The side that asks for data. It is initiating requests to one or many providers.
 
+A node can be a provider and a requester at the same time.
 
 ## Getting started
 
@@ -33,31 +34,31 @@ Here is a basic example of how to set up `iroh-blobs` with `iroh`:
 
 ```rust
 use iroh::{protocol::Router, Endpoint};
-use iroh_blobs::{store::Store, net_protocol::Blobs};
+use iroh_blobs::{store::mem::MemStore, BlobsProtocol};
 
 #[tokio::main]
 async fn main() -> anyhow::Result<()> {
     // create an iroh endpoint that includes the standard discovery mechanisms
     // we've built at number0
     let endpoint = Endpoint::builder().discovery_n0().bind().await?;
 
-    // create an in-memory blob store
-    // use `iroh_blobs::net_protocol::Blobs::persistent` to load or create a
-    // persistent blob store from a path
-    let blobs = Blobs::memory().build(&endpoint);
-
-    // turn on the "rpc" feature if you need to create blobs and tags clients
-    let blobs_client = blobs.client();
-    let tags_client = blobs_client.tags();
+    // create a protocol handler using an in-memory blob store.
+    let store = MemStore::new();
+    let blobs = BlobsProtocol::new(&store, endpoint.clone(), None);
 
     // build the router
     let router = Router::builder(endpoint)
         .accept(iroh_blobs::ALPN, blobs.clone())
         .spawn();
 
-    // do fun stuff with the blobs protocol!
+    let tag = blobs.add_slice(b"Hello world").await?;
+    println!("We are now serving {}", blobs.ticket(tag).await?);
+
+    // wait a second
+    tokio::time::sleep(std::time::Duration::from_secs(1)).await;
+
+    // clean shutdown of router and store
     router.shutdown().await?;
-    drop(tags_client);
     Ok(())
 }
 ```
@@ -81,4 +82,4 @@ at your option.
 
 Unless you explicitly state otherwise, any contribution intentionally submitted
 for inclusion in this project by you, as defined in the Apache-2.0 license,
-shall be dual licensed as above, without any additional terms or conditions.
+shall be dual licensed as above, without any additional terms or conditions.

src/lib.rs

@@ -1,4 +1,5 @@
-//! Blobs layer for iroh.
+#![doc = include_str!("../README.md")]
+//! # Module docs
 //!
 //! The crate is designed to be used from the [iroh] crate.
 //!
@@ -16,7 +17,11 @@
 //! 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
+//! The client API is available in the [api] module. You can get a client
+//! either from one of the [store] implementations, or from the [BlobsProtocol]
+//! via a
+//!
+//! The [downloader](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
@@ -35,12 +40,11 @@ pub use net_protocol::BlobsProtocol;
 pub mod protocol;
 pub mod provider;
 pub mod ticket;
-pub(crate) mod util;
+pub mod util;
 
 #[cfg(test)]
 mod tests;
 
-#[doc(hidden)]
 pub mod test;
 
 pub use protocol::ALPN;

src/net_protocol.rs

@@ -36,7 +36,7 @@
 //! # }
 //! ```
 
-use std::{fmt::Debug, future::Future, sync::Arc};
+use std::{fmt::Debug, future::Future, ops::Deref, sync::Arc};
 
 use iroh::{
     endpoint::Connection,
@@ -66,6 +66,14 @@ pub struct BlobsProtocol {
     pub(crate) inner: Arc<BlobsInner>,
 }
 
+impl Deref for BlobsProtocol {
+    type Target = Store;
+
+    fn deref(&self) -> &Self::Target {
+        &self.inner.store
+    }
+}
+
 impl BlobsProtocol {
     pub fn new(store: &Store, endpoint: Endpoint, events: Option<mpsc::Sender<Event>>) -> Self {
         Self {