Skip to content

Commit

Permalink
Add preview to readme and reword
Browse files Browse the repository at this point in the history
  • Loading branch information
natecraddock committed Sep 28, 2024
1 parent 62ca414 commit 1821f22
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,25 @@ zf is a fuzzy finder that excels at filtering filepaths:
* [because filenames are usually unique](https://nathancraddock.com/blog/in-search-of-a-better-finder/#data-collection), matches on filenames are prioritized
* when the query resembles a file path, zf [uses heuristics for a more accurate match](#strict-path-matching)

While it also functions as a general-purpose fuzzy finder, the goal of zf is to be more accurate than other fuzzy finders when filtering filepaths. If you find something that could be improved, please [let me know](https://github.com/natecraddock/zf/issues).
The goal of zf is to be more accurate than other fuzzy finders when filtering filepaths, but it also functions as a general-purpose fuzzy finder.

zf is also available as an allocation-free library for fuzzy filtering.
zf is also available as an allocation-free library for fuzzy filtering. [See the docs for more info](https://github.com/natecraddock/zf/blob/master/doc/lib.md).

[Try it online!](https://nathancraddock.com/zf-playground/)
[Try zf online!](https://nathancraddock.com/zf-playground/)

## Demo

https://user-images.githubusercontent.com/7967463/225198950-a6ab568f-644f-40a1-b202-c12a35aeaed8.mp4

## Features

* designed for fuzzy matching file paths (but also works as a general purpose fuzzy finder)
* fuzzy matching algorithm designed for file paths
* refine search results with whitespace separated query terms
* case insensitive unless the query contains uppercase letters (smartcase)
* smartcase (case insensitive unless the query contains uppercase letters)
* multiselect to output multiple selected lines
* preview window
* Zig and C libraries for the zf ranking algorithm

zf aims to be simple:
* no full-window interface
* minimal config and options
* sensible defaults

## Docs

* [Usage Documentation](https://github.com/natecraddock/zf/blob/master/doc/zf.md)
Expand Down

0 comments on commit 1821f22

Please sign in to comment.