Skip to content

Commit

Permalink
docs: add note in README
Browse files Browse the repository at this point in the history
  • Loading branch information
delphinus committed Apr 28, 2024
1 parent c645921 commit a609367
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,22 @@ See [default configuration](https://github.com/nvim-telescope/telescope.nvim#tel
Patterns in this table control which files are indexed (and subsequently
which you'll see in the finder results).

- `matcher` (default: `"default"`)

> ___CAUTION___<br>
> This option is highly experimental.
In default, it matches against candidates by the so-called “substr matcher”,
that is, you should input characters ordered properly separated by spaces
optionally. If you set here with `"fuzzy"`, it uses [_fzy_ matcher][fzy]
implemented in telescope itself, and combines the result with recency scores.
With this, you can select candidates fully _fuzzily_, besides that, ones that
has higher recency scores are easy to select.

See the discussion in https://github.com/nvim-telescope/telescope-frecency.nvim/issues/165.

[fzy]: https://github.com/jhawthorn/fzy

- `max_timestamps` (default: `10`)

Set the max count of timestamps DB keeps when you open files. It ignores the
Expand Down

0 comments on commit a609367

Please sign in to comment.