changeset 74:bc127bc534b5

Explain background in README
author Lewin Bormann <lbo@spheniscida.de>
date Mon, 17 Feb 2020 20:34:35 +0100
parents 27972ad163c8
children 1b359f9e98f4
files README.md
diffstat 1 files changed, 13 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Mon Feb 17 15:46:56 2020 +0100
+++ b/README.md	Mon Feb 17 20:34:35 2020 +0100
@@ -6,6 +6,8 @@
 
 [Documentation](https://docs.rs/sstable)
 
+## What
+
 This crate provides an API to work with immutable (string -> string) maps stored
 on disk. The main access method are iterators, but there's a simpler API, too.
 
@@ -27,4 +29,14 @@
 skipped. How many entries a single block contains depends on the block size,
 which can be set in the `Options` struct.
 
-Contributions are very welcome!
+## Why
+
+This crate reuses code originally written for the persistence part of
+[rusty-leveldb](https://crates.io/crates/rusty-leveldb), a reimplementation of
+Google's LevelDB in Rust. That's the reason for the code being a bit more
+complicated than needed at some points.
+
+## Contribute
+
+Contributions are very welcome! Feel free to send pull requests.
+