From cd6f65cc80c1e3e1d55b4f1cc28b8b792edd9a9e Mon Sep 17 00:00:00 2001
From: Dylan Bowker <dylan.bowker@arkiteq.ca>
Date: Sat, 18 Nov 2023 09:14:53 -0700
Subject: [PATCH] Update to documentation.

---
 CHANGELOG.md | 12 ++++++++++++
 README.md    |  8 ++++++--
 src/lib.rs   | 41 +----------------------------------------
 3 files changed, 19 insertions(+), 42 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9f72b20..573f6a3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,6 +3,18 @@
 * Release notes are available on
 [GitHub](https://github.com/leontoeides/indicium/releases).
 
+* `0.6.0`: New, optional `eddie` feature which is turned on by default. When
+this feature is enabled, this library will utilize
+[Ilia Schelokov](https://github.com/thaumant)'s [eddie](https://lib.rs/crates/eddie)
+crate for [faster](https://github.com/thaumant/eddie/blob/master/benchmarks.md)
+UTF-8 string distance and string similarity calculations.
+
+* `0.6.0`: New, optional `gxhash` feature. `ahash` is still the default hasher.
+When this feature is enabled, this library will utilize
+[Olivier Giniaux](https://github.com/ogxd)'s bleeding edge
+[gxhash](https://lib.rs/crates/gxhash) crate for faster `HashMap` and `HashSet`
+hashing.
+
 * `0.5.2`: New, optional `ahash` feature which is turned on by default. When
 this feature is enabled, this library will utilize
 [ahash](https://lib.rs/crates/ahash) for faster `HashMap` and `HashSet` hashing
diff --git a/README.md b/README.md
index a5e9d9c..9d79c7e 100644
--- a/README.md
+++ b/README.md
@@ -25,8 +25,12 @@ performance may begin to degrade at a point.
 
 # What's New?
 
-* The release notes on [GitHub](https://github.com/leontoeides/indicium/releases)
-will be used as the changelog going forward.
+* Release notes are available on
+[GitHub](https://github.com/leontoeides/indicium/releases).
+
+* The full [change
+log](https://github.com/leontoeides/indicium/blob/master/CHANGELOG.md) is
+available on GitHub.
 
 * `0.6.0`: New, optional `eddie` feature which is turned on by default. When
 this feature is enabled, this library will utilize
diff --git a/src/lib.rs b/src/lib.rs
index 98ec665..882f486 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -16,48 +16,9 @@
 //! [GitHub](https://github.com/leontoeides/indicium/releases).
 //!
 //! * The full [change
-//! log](https://github.com/leontoeides/indicium/blob/main/CHANGELOG.md) is
+//! log](https://github.com/leontoeides/indicium/blob/master/CHANGELOG.md) is
 //! available on GitHub.
 //!
-//! * `0.5.2`: New, optional `ahash` feature which is turned on by default. When
-//! this feature is enabled, this library will utilize
-//! [ahash](https://lib.rs/crates/ahash) for faster `HashMap` and `HashSet`
-//! hashing rather than the standard library's SipHash.
-//!
-//! * `0.5.1`: Fixes compile failure for the experimental `select2` feature and
-//! when not using `fuzzy` feature.
-//!
-//! * `0.5.0`: The `simple` search index now internally employs the
-//! [kstring](https://crates.io/crates/kstring) crate. This should help with
-//! performance in certain cases. The `dump_keyword` and `profile` function
-//! signatures were changed slightly, otherwise there's no impact to the caller.
-//!
-//! * `0.5.0`: Performance improvements.
-//!
-//! * `0.4.2`: Any type that implements
-//! [ToString](https://doc.rust-lang.org/std/string/trait.ToString.html) (and
-//! consequently any type that implements
-//! [Display](https://doc.rust-lang.org/std/fmt/trait.Display.html))
-//! now gets the
-//! [Indexable](https://docs.rs/indicium/latest/indicium/simple/trait.Indexable.html)
-//! implementation for free.
-//!
-//! * `0.4.1`: Improved contextual fuzzy matching.
-//!
-//! * `0.4.0`: Initial support for fuzzy searching. Fuzzy matching is applied to
-//! the last (partial) keyword in the search string for _autocompletion_ and
-//! _live search_ only. Keywords at the start or in the middle of the user's
-//! search string will not be substituted.
-//!
-//! * `0.4.0`: Breaking changes:
-//!     * Builder pattern is now passed owned values.
-//!     * `K` key type requires `Hash` trait for `fuzzy` string search feature.
-//!     * New `SearchIndex` default settings.
-//!
-//! * `0.4.0`: **Any dependent software should see if (or how) the updated
-//! defaults change search behaviour and tweak accordingly before adopting the
-//! 0.4.0 update.**
-//!
 //! # Quick Start Guide
 //!
 //! For our **Quick Start Guide** example, we will be searching inside of the