Skip to content

Commit 2526411

Browse files
committed
docs: update README
1 parent ba0e19e commit 2526411

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# FerrumKV 🦀
22

33
[![CI](https://github.com/phaethix/ferrum-kv/actions/workflows/ci.yml/badge.svg)](https://github.com/phaethix/ferrum-kv/actions/workflows/ci.yml)
4-
![version](https://img.shields.io/badge/version-v0.2.0-blue)
4+
![version](https://img.shields.io/badge/version-v0.3.0-blue)
55

66
A lightweight, multi-threaded KV storage server written in Rust — built from scratch for systems programming practice.
77

@@ -156,12 +156,12 @@ Fsync policies follow Redis semantics:
156156
## Testing & Benchmarks
157157

158158
```bash
159-
cargo test # all unit + integration tests (82 unit tests, 5 integration suites)
159+
cargo test # all unit + integration tests (185 unit + 9 integration suites)
160160
cargo bench # Criterion microbenchmarks (engine + RESP2 codec)
161161
./scripts/bench-smoke.sh # native load generator: SET / GET / MIXED @ 100K ops
162162
```
163163

164-
The GitHub Actions pipeline runs `cargo fmt --check`, `cargo clippy -- -D warnings`, `cargo test`, and `cargo bench --no-run` on every push and pull request.
164+
The GitHub Actions pipeline runs `cargo fmt --check`, `cargo clippy -- -D warnings`, `cargo test`, and `cargo bench --no-run` on every push and pull request. A `redis-benchmark` smoke run against a release binary (loopback, 100K ops, 50 clients) is captured in [`benches/redis-benchmark.md`](benches/redis-benchmark.md) and refreshed at release time.
165165

166166
## Roadmap
167167

@@ -174,8 +174,8 @@ The GitHub Actions pipeline runs `cargo fmt --check`, `cargo clippy -- -D warnin
174174
- [x] Structured logging (`log` + `env_logger`) & Redis-style config file
175175
- [x] Unit / integration / concurrency tests + Criterion benchmarks + CI
176176
- [x] Key expiration: `EXPIRE` / `PEXPIRE` / `PEXPIREAT` / `PERSIST` / `TTL` / `PTTL` with lazy + active scanning
177-
- [x] Memory cap + sampled eviction: `noeviction` / `allkeys_lru` / `allkeys_random` / `volatile_lru` / `volatile_random` / `volatile_ttl` (+ `MEMORY USAGE`, `INFO memory`)
178-
- [ ] LFU & adaptive hybrid eviction (AHE) — *Week 7, in progress*
177+
- [x] Memory cap + sampled eviction: `noeviction` / `allkeys-lru` / `allkeys-lfu` / `allkeys-random` / `allkeys-ahe` / `volatile-lru` / `volatile-lfu` / `volatile-random` / `volatile-ttl` / `volatile-ahe`
178+
- [x] Observability: `MEMORY USAGE`, `INFO memory` (incl. `ahe_alpha`), `INFO stats` (`keyspace_hits` / `keyspace_misses`)
179179
- [ ] Async I/O (Tokio)
180180

181181
## License

0 commit comments

Comments
 (0)