Skip to content

Commit

Permalink
adjust readme
Browse files Browse the repository at this point in the history
  • Loading branch information
marvin-j97 committed Jun 9, 2024
1 parent 0a515d4 commit 2a36278
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Generic value log implementation for key-value separated storage, inspired by Ro
- 100% safe & stable Rust
- Supports generic KV-index structures (LSM-tree, ...)
- Built-in per-blob compression (LZ4)
- In-memory blob cache for hot data, that can be shared between multiple value logs
- In-memory blob cache for hot data - can be shared between multiple value logs to cap memory usage

Keys are limited to 65536 bytes, values are limited to 2^32 bytes.

Expand All @@ -33,6 +33,12 @@ Allows using `LZ4` compression, powered by [`lz4_flex`](https://github.com/PSeit

*Enabled by default.*

### serde

Enables `serde` derives.

*Disabled by default.*

## Stable disk format

The disk format is stable as of 1.0.0. Future breaking changes will result in a major version bump and a migration path.
Expand Down

0 comments on commit 2a36278

Please sign in to comment.