Skip to content

Commit

Permalink
chore: add link to unicode branch in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fjebaker committed Jan 9, 2025
1 parent bf425e3 commit f4b278b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Fuzzy finder algorithms in Zig based on the [Smith-Waterman algorithm](https://en.wikipedia.org/wiki/Smith%E2%80%93Waterman_algorithm), inspired by [fzf](https://github.com/junegunn/fzf).

For Unicode support, use the [unicode branch](https://github.com/fjebaker/unicode/tree/unicode).

## Example

```zig
Expand Down Expand Up @@ -57,8 +59,6 @@ The module defines an `Algorithm` generic type, which accepts the element type o
- Algorithms only have `score` and `scoreMatches` as public functions.
- If not matches are detected, the score will be `null`.

This package currently implements ASCII and Unicode (compile with `-Dunicode`) fuzzy finders. The fuzzy finder implementation should be flexible enough to extend to other data types or character encodings in downstream packages by providing your own wrapper around `AlgorithmType`. See the ASCII and Unicode implementations for examples.

## Usage

The library was written with Zig 0.12.0-dev.3541+05b185811, but there is likely a lot of flexibility with versioning.
Expand Down

0 comments on commit f4b278b

Please sign in to comment.