whatcanGOwrong

go/pkg/mod/github.com/derekparker/trie@v0.0.0-20230829180723-39f4de51ef7d/README.md

@@ -0,0 +1,62 @@
+[![GoDoc](https://godoc.org/github.com/derekparker/trie?status.svg)](https://godoc.org/github.com/derekparker/trie)
+
+# Trie
+Data structure and relevant algorithms for extremely fast prefix/fuzzy string searching.
+
+## Usage
+
+Create a Trie with:
+
+```Go
+t := trie.New()
+```
+
+Add Keys with:
+
+```Go
+// Add can take in meta information which can be stored with the key.
+// i.e. you could store any information you would like to associate with
+// this particular key.
+t.Add("foobar", 1)
+```
+
+Find a key with:
+
+```Go
+node, ok := t.Find("foobar")
+meta := node.Meta()
+// use meta with meta.(type)
+```
+
+Remove Keys with:
+
+```Go
+t.Remove("foobar")
+```
+
+Prefix search with:
+
+```Go
+t.PrefixSearch("foo")
+```
+
+Fast test for valid prefix:
+```Go
+t.HasKeysWithPrefix("foo")
+```
+
+Fuzzy search with:
+
+```Go
+t.FuzzySearch("fb")
+```
+
+## Contributing
+Fork this repo and run tests with:
+
+	go test
+
+Create a feature branch, write your tests and code and submit a pull request.
+
+## License
+MIT