summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1c4bf5d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+BTree
+=====
+
+An array based C-implementation of BTrees attempting a reasonable performance.
+
+_a B-tree is a self-balancing tree data structure that maintains sorted data and
+allows searches, sequential access, insertions, and deletions in logarithmic
+time_
+ -- [Wikipedia](https://en.wikipedia.org/wiki/B-tree)
+
+BTrees are -- algorithm wise -- implemented using pointers to subtrees which is
+horribly slow on hardware. This project aims to optimize this, by putting the
+whole struct into an array which can be iterated through in-order.
+
+
+## Installation
+
+todo
+
+
+## Usage
+
+todo