KDTree WrapperHEADmain

1 files changed, 20 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0536e80
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+KDTree Wrapper
+==============
+
+A simple C++ wrapper for John Tsiombikas's kd-tree library.
+
+```
+KDTree<PointT, LabelT, Dims> kdtree;
+```
+
+PointT: 
+- must contain a constructor to recieve points via a double buffer [double*]
+- must have a .data() method that produces a double buffer
+
+LabelT:
+-  modifiable
+
+Dims:
+- Number of dimensions in PointT
+
+Search methods return `ResultSet` which acts similar to an iterator with more contraints
\ No newline at end of file