Add notes to README

akullpp · akullpp · commit 57e81f694c5b · 2019-12-06T23:02:16.000+01:00
diff --git a/README.md b/README.md
@@ -23,3 +23,6 @@ Descriptions taken from [trekhleb/javascript-algorithms](https://github.com/trek
 * Tree
 * Trie
 
+# Notes
+
+The implementation is done with an educational purpose in mind, which means that the datastructures and algorithms do not provide a caller-friendly API, e.g. `LinkedList#append(Node<T> n)` instead of `LinkedList#append(T t)` or use visibility modifiers for access control because readability is key.

-Original file line number
+Diff line change
 * Tree
 * Trie
 +# Notes
++
 +The implementation is done with an educational purpose in mind, which means that the datastructures and algorithms do not provide a caller-friendly API, e.g. `LinkedList#append(Node<T> n)` instead of `LinkedList#append(T t)` or use visibility modifiers for access control because readability is key.