diff --git a/storage/service/README.md b/storage/service/README.md index 85b4d2d8..32e743c6 100644 --- a/storage/service/README.md +++ b/storage/service/README.md @@ -1,6 +1,7 @@ # Cuprate's `tower::Service` database abstraction. -This crate contains the building blocks for creating a `tower::Service` interface to `cuprate_blockchain`. +This crate contains the building blocks for creating a [`tower::Service`] interface to [`cuprate_blockchain`](https://doc.cuprate.org/cuprate_blockchain). -It is split into 2 `tower::Service`s a read service which is backed by a `rayon::ThreadPool` and a write service which -spawns a single thread to handle write requests. +It is split into 2 `tower::Service`s: +1. A [read service](crate::DatabaseReadService) which is backed by a [`rayon::ThreadPool`] +1. A [write service](crate::DatabaseWriteHandle) which spawns a single thread to handle write requests