changeset 376:f3d44aa3fbdf

Meta: Update Readme
author Lewin Bormann <lbo@spheniscida.de>
date Sun, 08 Oct 2017 15:58:34 +0200
parents dcb6adc4114f
children a745eb80bca4
files README.md
diffstat 1 files changed, 10 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Sun Oct 08 15:52:51 2017 +0200
+++ b/README.md	Sun Oct 08 15:58:34 2017 +0200
@@ -1,11 +1,18 @@
 # leveldb-rs
 
-A fully compatible implementation of LevelDB in Rust.
+**Goal:** A fully compatible implementation of LevelDB in Rust.
+
+The implementation is very close to the original; often, you can see the same
+algorithm translated 1:1, and class (struct) and method names are similar or
+the same.
 
 ## Status
 
-In development; most of the infrastructure exists, but the actual database logic
-has not yet been implemented.
+* User-facing methods exist: Read/Write/Delete; snapshots; iteration
+* Compaction is supported, but no manual ones.
+* Fully synchronous: Efficiency gains by using non-atomic types, but writes may
+  occasionally block during a compaction.
+* Compatibility: Not yet assessed.
 
 ## Goals