Browse Source

Add a README.md (No functional changes).

Yawning Angel 1 year ago
parent
commit
0a87673719
1 changed files with 25 additions and 0 deletions
  1. 25 0
      README.md

+ 25 - 0
README.md

@@ -0,0 +1,25 @@
+### AVL - AVL tree
+#### Yawning Angel (yawning at schwanenlied dot me)
+
+[![GoDoc](https://godoc.org/git.schwanenlied.me/yawning/avl.git?status.svg)](https://godoc.org/git.schwanenlied.me/yawning/avl.git)
+
+A generic Go AVL tree implementation, derived from [Eric Biggers' C code][1],
+in the spirt of [the runtime library's containers][2].
+
+Features:
+
+ * Size
+ * Insertion
+ * Deletion
+ * Search
+ * In-order traversal (forward and backward) with an iterator or callback.
+ * Non-recursive.
+
+Note:
+
+ * The package itself is free from external dependencies, the unit tests use
+   [testify][3].
+
+[1]: https://github.com/ebiggers/avl_tree
+[2]: https://golang.org/pkg/container
+[3]: https://github.com/stretchr/testify