chore: update badge with link (#721)

* chore: update badge with link Signed-off-by: MrCroxx <[email protected]> * chore: center the badges Signed-off-by: MrCroxx <[email protected]> * chore: add website center Signed-off-by: MrCroxx <[email protected]> * chore: fix link Signed-off-by: MrCroxx <[email protected]> * chore: add more guides Signed-off-by: MrCroxx <[email protected]> * chore: add links in rust doc Signed-off-by: MrCroxx <[email protected]> * chore: update Signed-off-by: MrCroxx <[email protected]> --------- Signed-off-by: MrCroxx <[email protected]>
foyer-rs · Sep 19, 2024 · 474fd2f · 474fd2f
1 parent c28c6c1
commit 474fd2f
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -2,13 +2,22 @@
     <img src="https://raw.githubusercontent.com/foyer-rs/foyer/main/etc/logo/slogan.min.svg" />
 </p>
 
-<div style="text-align: center;">
-
-![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)
+<p align="center">
+    <a href="https://foyer.rs">
+        <img src="https://img.shields.io/website?url=https%3A%2F%2Ffoyer.rs&up_message=foyer.rs&down_message=website&style=for-the-badge&logo=htmx" alt="docs.rs" />
+    </a>
+    <a href="https://crates.io/crates/foyer">
+        <img src="https://img.shields.io/crates/v/foyer?style=for-the-badge&logo=crates.io&labelColor=555555" alt="crates.io" />
+    </a>
+    <a href="https://docs.rs/foyer">
+        <img src="https://img.shields.io/docsrs/foyer?style=for-the-badge&logo=rust&label=docs.rs&labelColor=555555" alt="docs.rs" />
+    </a>
+</p>
 
-</div>
+<p align="center">
+    <b>Tutorial & Document:</b>
+    <a href="https://foyer.rs"><b>https://foyer.rs</b></a>
+</p>
 
 # foyer
 
@@ -26,6 +35,11 @@ However, *foyer* is more than just a *rewrite in Rust* effort; it introduces a v
 
 For more details, please visit foyer's website: https://foyer.rs 🥰
 
+[Website](https://foyer.rs) |
+[Tutorial](https://foyer.rs/docs/overview) |
+[API Docs](https://docs.rs/foyer) |
+[Crate](https://crates.io/crates/foyer)
+
 ## Features
 
 - **Hybrid Cache**: Seamlessly integrates both in-memory and disk cache for optimal performance and flexibility.
@@ -42,14 +56,10 @@ 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.
 
-## Document
-
-Tutorial & Document: https://foyer.rs
-
-API References: https://docs.rs/foyer
-
 ## Quick Start
 
+**This section only shows briefs. Please visit https://foyer.rs for more details.**
+
 To use *foyer* in your project, add this line to the `dependencies` section of `Cargo.toml`.
 
 ```toml

diff --git a/foyer/src/lib.rs b/foyer/src/lib.rs
@@ -18,9 +18,14 @@
 
 //! 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)
+//! ![Website](https://img.shields.io/website?url=https%3A%2F%2Ffoyer.rs&up_message=foyer.rs&down_message=website&style=for-the-badge&logo=htmx&link=https%3A%2F%2Ffoyer.rs)
+//! ![Crates.io Version](https://img.shields.io/crates/v/foyer?style=for-the-badge&logo=crates.io&labelColor=555555&link=https%3A%2F%2Fcrates.io%2Fcrates%2Ffoyer)
+//! ![docs.rs](https://img.shields.io/docsrs/foyer?style=for-the-badge&logo=rust&label=docs.rs&labelColor=555555&link=https%3A%2F%2Fdocs.rs%2Ffoyer)
+//!
+//! [Website](https://foyer.rs) |
+//! [Tutorial](https://foyer.rs/docs/overview) |
+//! [API Docs](https://docs.rs/foyer) |
+//! [Crate](https://crates.io/crates/foyer)
 
 use foyer_common as common;
 use foyer_memory as memory;