README

uzyn · May 7, 2024 · 0721283 · 0721283
1 parent c1f57ed
commit 0721283
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,21 @@
 # SparKV
 
 SparKV is an expirable in-memory key-value store for Rust.
+
+## Features
+
+1. Flexible item-level TTL, with a pre-defined default TTL.
+2. Automatically clear expired entries. Can be turn off in Config.
+3. String based key-value store.
+4. Enforceable value and store size.
+5. SparKV is intentionally not an LRU cache.
+
+## TODO
+
+1. Documentations
+1. Support generic data types
+
+## License
+
+MIT License<br>
+Copyright (c) 2024 U-Zyn Chua