tweak(docs): some love and attention

Author: DevBlocky

README.md

@@ -35,6 +35,7 @@ It is advisable to use another solution if you have the option!
 - Asynchronous APIs
 - Fast and reliable reading/writing
 - Tuned for large-file databases
+- Included cache eviction (LRU/FIFO)
 - Easily accessible value metadata
 - Optimized for cache `HIT`s
 - Easy error handling
@@ -44,7 +45,6 @@ It is advisable to use another solution if you have the option!
 
 - Toggleable in-memory LRU cache
 - Optional tracking of last-access timestamps
-- Included cache eviction (LRU/FIFO)
 - Built-in cache integrity checks
 
 ## Documentation

src/cache.rs

@@ -30,11 +30,16 @@ pub(crate) struct Options {
     pub(crate) wbuff_sz: usize,
 }
 
-/// The main component of `forceps`, acts as the API for interacting with the on-disk API.
+/// The main component of `forceps`, and  acts as the API for interacting with the on-disk cache.
 ///
-/// This structure exposes `read`, `write`, and misc metadata operations. `read` and `write` are
-/// both async, whereas all metadata operations are sync. See [`CacheBuilder`](crate::CacheBuilder)
-/// for all customization options.
+/// This structure includes the async `read`, `write`, and `remove` operations which are the basic
+/// operations of the cache. It also includes some misc functions to interact with metadata and
+/// evict items from the cache.
+///
+/// # Eviction
+///
+/// This cache can evict items with a number of different eviction algorithms. To see more, see
+/// [`evict_with`] and the [`evictors`] module.
 ///
 /// # Examples
 ///
@@ -49,6 +54,9 @@ pub(crate) struct Options {
 ///     .unwrap();
 /// # }
 /// ```
+///
+/// [`evict_with`]: #method.evict_with
+/// [`evictors`]: crate::evictors
 #[derive(Debug)]
 pub struct Cache {
     meta: MetaDb,

src/lib.rs

@@ -14,6 +14,7 @@
 //! - Asynchronous APIs
 //! - Fast and reliable reading/writing
 //! - Tuned for large-file databases
+//! - Included cache eviction (LRU/FIFO)
 //! - Easily accessible value metadata
 //! - Optimized for cache `HIT`s
 //! - Easy error handling
@@ -31,9 +32,9 @@
 //!
 //! # Examples
 //!
-//! ```rust
-//! # #[tokio::main(flavor = "current_thread")]
-//! # async fn main() {
+//! ```rust,no_run
+//! #[tokio::main]
+//! async fn main() {
 //! use forceps::Cache;
 //!
 //! let cache = Cache::new("./cache")
@@ -44,7 +45,7 @@
 //! cache.write(b"MY_KEY", b"Hello World").await.unwrap();
 //! let data = cache.read(b"MY_KEY").await.unwrap();
 //! assert_eq!(data.as_ref(), b"Hello World");
-//! # }
+//! }
 //! ```
 
 #![warn(missing_docs)]