From f4b278b7de531e1310586b7b4bdfa66b51eb6260 Mon Sep 17 00:00:00 2001 From: fjebaker Date: Thu, 9 Jan 2025 20:44:30 +0000 Subject: [PATCH] chore: add link to unicode branch in readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 486d9a9..e43bc62 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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.