Skip to content

Commit

Permalink
docs: Top-of-README tagline
Browse files Browse the repository at this point in the history
  • Loading branch information
alexpovel committed Jan 22, 2024
1 parent 2bdc94c commit c6ccf71
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,16 @@
# b4s

Binary Search Single Sorted String: Perform binary search on a single, delimited string
slice of sorted but unevenly sized substrings.
slice of sorted but unevenly sized substrings. This crate might be useful if you...

- have a pre-sorted (`build.rs`, ...) list of words, and
- need to check if a word is contained,
- with low overhead, no allocations, minimal extra dependencies.

In a drop-in manner, this crate replaces linear with binary search for corresponding
speed-ups in suitable cases, delivering faster runtime at virtually no extra cost
(writing this yourself is easy enough, but this crate is tested and fuzzed :-) ). See
below for [more](#motivation), and [benchmarks](#benchmarks).

The docs are best viewed via [docs.rs](https://docs.rs/b4s).

Expand Down

0 comments on commit c6ccf71

Please sign in to comment.