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 0e6ae72 commit 4402884
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ repository = "https://github.com/leontoeides/indicium"
maintenance = { status = "actively-developed" }

[features]
default = [ "simple", "strsim", "ahash" ]
default = [ "simple", "eddie", "gxhash" ]
simple = []
select2 = [ "simple", "serde" ]
ahash = [ "dep:ahash" ]
Expand Down
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,22 @@ performance may begin to degrade at a point.
* The release notes on [GitHub](https://github.com/leontoeides/indicium/releases)
will be used as the changelog going forward.

* `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 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
rather than the standard library's SipHash.
[Tom Kaitchuck](https://crates.io/users/tkaitchuck)'s [ahash](https://lib.rs/crates/ahash)
crate 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.
Expand All @@ -56,7 +68,9 @@ implementation for free.
* `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.
will not be substituted. Indicium uses [Danny Guo](https://github.com/dguo)'s
[strsim](https://crates.io/crates/strsim) crate for string similarity
calculations.

* `0.4.0`: Breaking changes:
* Builder pattern is now passed owned values.
Expand Down

0 comments on commit 4402884

Please sign in to comment.