From a37c55a1c8a781c3dfd7e921e4088ba15b7f0fe2 Mon Sep 17 00:00:00 2001 From: Matt Joiner Date: Sun, 21 Jul 2024 22:58:08 +1000 Subject: [PATCH] Add badges to README --- README.adoc | 3 +++ README.md | 3 +++ 2 files changed, 6 insertions(+) diff --git a/README.adoc b/README.adoc index 4c1140e..9a7fc48 100644 --- a/README.adoc +++ b/README.adoc @@ -1,5 +1,8 @@ = Possum +image:https://img.shields.io/crates/v/possum-db[Crates.io Version,link=https://crates.io/crates/possum-db] +image:https://img.shields.io/docsrs/possum-db[docs.rs,link=https://docs.rs/possum-db/latest/possum/] + == What is it? Possum is a key-value cache stored directly on disk. It supports concurrent access from multiple processes without requiring interprocess communication or sidecar processes. It efficiently evicts data by using hole punching and sparse files. It supports read snapshots by using file cloning, a feature available on https://www.ctrl.blog/entry/file-cloning.html[filesystems] such as Btrfs, XFS, ZFS, APFS and ReFSv2. diff --git a/README.md b/README.md index c70d03f..ccc4557 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # Possum +![Crates.io Version](https://img.shields.io/crates/v/possum-db) +![docs.rs](https://img.shields.io/docsrs/possum-db) + ## What is it? Possum is a key-value cache stored directly on disk. It supports concurrent access from multiple processes without requiring interprocess communication or sidecar processes. It efficiently evicts data by using hole punching and sparse files. It supports read snapshots by using file cloning, a feature available on [filesystems](https://www.ctrl.blog/entry/file-cloning.html) such as Btrfs, XFS, ZFS, APFS and ReFSv2.