Skip to content
This repository was archived by the owner on Sep 5, 2025. It is now read-only.

Commit 7ac144f

Browse files
authored
Update README.md
1 parent 051e756 commit 7ac144f

1 file changed

Lines changed: 2 additions & 58 deletions

File tree

README.md

Lines changed: 2 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,4 @@
1-
<p align="center">
2-
<img src="/logo.png" height="160">
3-
</p>
4-
<p align="center>
5-
(temporary logo)
6-
</p>
7-
8-
[![CI](https://github.com/fjall-rs/value-log/actions/workflows/test.yml/badge.svg)](https://github.com/fjall-rs/value-log/actions/workflows/test.yml)
9-
[![docs.rs](https://img.shields.io/docsrs/value-log?color=green)](https://docs.rs/value-log)
10-
[![Crates.io](https://img.shields.io/crates/v/value-log?color=blue)](https://crates.io/crates/value-log)
11-
![MSRV](https://img.shields.io/badge/MSRV-1.74.0-blue)
12-
[![dependency status](https://deps.rs/repo/github/fjall-rs/value-log/status.svg)](https://deps.rs/repo/github/fjall-rs/value-log)
13-
14-
Generic value log implementation for key-value separated storage, inspired by RocksDB's BlobDB [[1]](#footnotes) and Titan [[2]](#footnotes) and implemented in safe, stable Rust.
1+
# value-log
152

163
> [!NOTE]
17-
> This crate is intended as a building block for key-value separated storage.
18-
> You probably want to use https://github.com/fjall-rs/fjall instead.
19-
20-
## Features
21-
22-
- Thread-safe API
23-
- 100% safe & stable Rust
24-
- Supports generic KV-index structures (LSM-tree, ...)
25-
- Generic per-blob compression (optional)
26-
- In-memory blob cache for hot data (can be shared between multiple value logs to cap memory usage)
27-
- On-line garbage collection
28-
29-
Keys are limited to 65536 bytes, values are limited to 2^32 bytes.
30-
31-
## Feature flags
32-
33-
### serde
34-
35-
Enables `serde` derives.
36-
37-
*Disabled by default.*
38-
39-
### bytes
40-
41-
Uses [`bytes`](https://github.com/tokio-rs/bytes) as the underlying `Slice` type.
42-
43-
*Disabled by default.*
44-
45-
## Stable disk format
46-
47-
The disk format is stable as of 1.0.0.
48-
49-
## License
50-
51-
All source code is licensed under MIT OR Apache-2.0.
52-
53-
All contributions are to be licensed as MIT OR Apache-2.0.
54-
55-
## Footnotes
56-
57-
[1] https://github.com/facebook/rocksdb/wiki/BlobDB
58-
59-
[2] https://docs.pingcap.com/tidb/stable/titan-overview/
60-
4+
> This crate has been moved into https://github.com/fjall-rs/lsm-tree.

0 commit comments

Comments
 (0)