From c28c6c1a81c793ce3d20c4ba73943a01df47f0c9 Mon Sep 17 00:00:00 2001 From: Croxx Date: Thu, 19 Sep 2024 14:24:15 +0800 Subject: [PATCH] chore: update readme, add website (#719) Signed-off-by: MrCroxx --- README.md | 24 +++++++++++++++++++----- foyer/src/lib.rs | 4 ++++ 2 files changed, 23 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6ea75be1..a878d205 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,18 @@

+
+ +![Website](https://img.shields.io/website?url=https%3A%2F%2Ffoyer.rs&up_message=foyer.rs&style=for-the-badge&logo=rust&labelColor=555555) +![Crates.io Version](https://img.shields.io/crates/v/foyer?style=for-the-badge&logo=docs.rs&labelColor=555555) +![docs.rs](https://img.shields.io/docsrs/foyer?style=for-the-badge&logo=docs.rs&labelColor=555555) + +
+ # foyer -![Crates.io Version](https://img.shields.io/crates/v/foyer) -![Crates.io MSRV](https://img.shields.io/crates/msrv/foyer) ![GitHub License](https://img.shields.io/github/license/foyer-rs/foyer) - +![Crates.io MSRV](https://img.shields.io/crates/msrv/foyer) [![CI](https://github.com/foyer-rs/foyer/actions/workflows/ci.yml/badge.svg)](https://github.com/foyer-rs/foyer/actions/workflows/ci.yml) [![License Checker](https://github.com/foyer-rs/foyer/actions/workflows/license_check.yml/badge.svg)](https://github.com/foyer-rs/foyer/actions/workflows/license_check.yml) [![codecov](https://codecov.io/github/foyer-rs/foyer/branch/main/graph/badge.svg?token=YO33YQCB70)](https://codecov.io/github/foyer-rs/foyer) @@ -18,9 +24,11 @@ foyer draws inspiration from [Facebook/CacheLib](https://github.com/facebook/cac However, *foyer* is more than just a *rewrite in Rust* effort; it introduces a variety of new and optimized features. +For more details, please visit foyer's website: https://foyer.rs 🥰 + ## Features -- **Hybrid Cache**: Seamlessly integrates both in-memory and disk-based caching for optimal performance and flexibility. +- **Hybrid Cache**: Seamlessly integrates both in-memory and disk cache for optimal performance and flexibility. - **Plug-and-Play Algorithms**: Empowers users with easily replaceable caching algorithms, ensuring adaptability to diverse use cases. - **Fearless Concurrency**: Built to handle high concurrency with robust thread-safe mechanisms, guaranteeing reliable performance under heavy loads. - **Zero-Copy In-Memory Cache Abstraction**: Leveraging Rust's robust type system, the in-memory cache in foyer achieves a better performance with zero-copy abstraction. @@ -34,7 +42,13 @@ Feel free to open a PR and add your projects here: - [RisingWave](https://github.com/risingwavelabs/risingwave): SQL stream processing, analytics, and management. - [Chroma](https://github.com/chroma-core/chroma): Embedding database for LLM apps. -## Usage +## Document + +Tutorial & Document: https://foyer.rs + +API References: https://docs.rs/foyer + +## Quick Start To use *foyer* in your project, add this line to the `dependencies` section of `Cargo.toml`. diff --git a/foyer/src/lib.rs b/foyer/src/lib.rs index dc0710cd..27a1f61f 100644 --- a/foyer/src/lib.rs +++ b/foyer/src/lib.rs @@ -17,6 +17,10 @@ #![warn(clippy::allow_attributes)] //! A hybrid cache library that supports plug-and-play cache algorithms, in-memory cache and disk cache. +//! +//! ![Crates.io Version](https://img.shields.io/crates/v/foyer?style=for-the-badge&logo=docs.rs&labelColor=555555) +//! ![docs.rs](https://img.shields.io/docsrs/foyer?style=for-the-badge&logo=docs.rs&labelColor=555555) +//! ![Website](https://img.shields.io/website?url=https%3A%2F%2Ffoyer.rs&up_message=foyer.rs&style=for-the-badge&logo=rust&labelColor=555555) use foyer_common as common; use foyer_memory as memory;