diff --git a/README.md b/README.md index 50607ee..806ee7a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ # bst-rs -A simple BST implementation within Rust + +> Recursive & Iterative Binary Search Tree Implementations within Rust + +## Table of Contents +- [Personal Goals](#Personal-Goals) +- [Usage](#Usage) +- [License](#License) +- [Inspiration](#Inspiration) + +## Personal Goals + +One of the main motivations for starting this is to fully grasp the following concepts + +- [x] Ownership/Borrowing +- [x] Generic Traits +- [x] Lifetimes + +I am now more confident programming around these concepts and can discuss and reason +about different implementations. + +## Usage + +TODO + +## License + +[MIT License](LICENSE) + +## Inspiration + +The book [Learning Rust With Too Many Linked Lists]() inspired me to try and +implement a Binary Search Trees within the language. I had also been wanting to create +my first library for other crates to use. \ No newline at end of file