update readme

Signed-off-by: Keming <kemingy94@gmail.com>
kemingy · Oct 3, 2024 · b79994d · b79994d
1 parent 0d969bd
commit b79994d
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "rabitq"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 description = "A Rust implementation of the RaBitQ vector search algorithm."
 license = "AGPL-3.0"

diff --git a/README.md b/README.md
@@ -1,3 +1,17 @@
 # RaBitQ
 
+[![AGPL](https://img.shields.io/github/license/kemingy/rabitq)](https://www.tldrlegal.com/license/gnu-affero-general-public-license-v3-agpl-3-0)
+[![crates.io](https://img.shields.io/crates/v/rabitq.svg)](https://crates.io/crates/rabitq)
+[![docs.rs](https://docs.rs/rabitq/badge.svg)](https://docs.rs/rabitq)
+[![Rust](https://github.com/kemingy/rabitq/actions/workflows/rust.yml/badge.svg)](https://github.com/kemingy/rabitq/actions/workflows/rust.yml)
+
 [RaBitQ](https://github.com/gaoj0017/RaBitQ) implementation in Rust.
+
+## Features
+
+- [x] RaBitQ with basic scan
+- [ ] RaBitQ with fastscan
+- [x] x86_64 SIMD support
+- [ ] integrate with K-means clustering
+- [ ] disk-based RaBitQ (WIP)
+- [ ] HTTP service (WIP)