Skip to content

Commit

Permalink
docs: add a short explanation of the search and filter algorithm (#97)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikavilpas authored Jan 8, 2025
1 parent 8de4ccb commit f707cce
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,23 @@ return {
}
```

## 🤔 How it works

When you enter insert mode and start typing a word, blink triggers a search with
blink-ripgrep. Only one search is done to save resources. After getting the
results, the following keys are used to filter the results.

In this demo (using the option `debug = true` above), we can see the search
starting when the word flashes with a different color. Notice how the word only
flashes once:

<!-- TODO add a better demo -->

<https://github.com/user-attachments/assets/0651ad24-0403-4ab9-81ff-59b152283593>

This is described in much more detail in blink's
[architecture documentation](https://cmp.saghen.dev/development/architecture.html).

## 🏁 Performance

Generally performance is very good, but depending on the size of your project
Expand Down

0 comments on commit f707cce

Please sign in to comment.