update docstring

Author: subpath

README.md

@@ -1,6 +1,6 @@
 # weighted_trie
 
-🦀 Rust crate that allows to create weighted prefix trees that can be used in autocomplete
+🦀 Rust crate that allows creating weighted prefix trees that can be used in autocomplete
 
 ### Quickstart
 To use weigthed-trie, add the following to your Cargo.toml file:
@@ -43,6 +43,12 @@ fn main() {
 Do not manually update `README.md` instead edit `src/lib.rs`
 and then run `cargo readme > README.md`.
 
+### TODO:
+1. Measure memory footprint
+2. Benrchmark lookup speed
+3. Try low hanging fruit optimizations like usage of `hashbrown` instead of standart HashMap
+
+
 ### License
 
 License: Apache-2.0

src/lib.rs

@@ -1,4 +1,4 @@
-//! 🦀 Rust crate that allows to create weighted prefix trees that can be used in autocomplete
+//! 🦀 Rust crate that allows creating weighted prefix trees that can be used in autocomplete
 //!
 //! ## Quickstart
 //! To use weigthed-trie, add the following to your Cargo.toml file:
@@ -41,6 +41,12 @@
 //! Do not manually update `README.md` instead edit `src/lib.rs`
 //! and then run `cargo readme > README.md`.
 //!
+//! ## TODO:
+//! 1. Measure memory footprint
+//! 2. Benrchmark lookup speed
+//! 3. Try low hanging fruit optimizations like usage of `hashbrown` instead of standart HashMap
+//!
+//!
 //! ## License
 pub use trie::WeightedTrie;
 pub mod trie;