Add badges to README

anacrolix · Jul 21, 2024 · a37c55a · a37c55a
1 parent d259f74
commit a37c55a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git 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
@@ -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.