Skip to content

Commit

Permalink
Update to documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
leontoeides committed Nov 18, 2023
1 parent fd3a545 commit cd6f65c
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 42 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
41 changes: 1 addition & 40 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit cd6f65c

Please sign in to comment.