aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDefaultGen <gravel.justness270@slmail.me>2024-06-20 03:06:14 -0400
committerDefaultGen <gravel.justness270@slmail.me>2024-06-20 03:06:14 -0400
commitb8b17b0402a5996144dc099748ea4c18f576ac1b (patch)
treef481fededc59985df6b8f3e4103221adfd142df6 /README.md
parent23a89932e57b50a8e9064b9c7ba329e62c88bc44 (diff)
downloaddenote-fzf-lua-b8b17b0402a5996144dc099748ea4c18f576ac1b.tar.gz
Working file and rg searches
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 27 insertions, 1 deletions
diff --git a/README.md b/README.md
index ecb49b1..e9ff351 100644
--- a/README.md
+++ b/README.md
@@ -4,5 +4,31 @@ Neovim plugin that uses `fzf-lua` to search a directory of notes formatted with
`DATE==SIGNATURE--TITLE__KEYWORDS.EXTENSION`
-The nice custom table for Denote files is the only unique 'feature' of this plugin. If you don't care about that you should use your existing search plugin.
+The nice custom table for Denote files is the only unique 'feature' of this plugin. If you don't care about that you should just use `fzf-lua` on its own.
+## Dependencies
+
+* `fzf` - Fuzzy finder
+* `ripgrep` - Fast `grep` replacement
+* `fd` (OPTIONAL) - Fast `find` replacement
+* `sd` (OPTIONAL) - Fast `sed` replacement
+* `qsv` (OPTIONAL) - Fast `column` replacement
+
+```
+Arch Linux: sudo pacman -S fzf ripgrep fd sd
+ yay -S qsv-bin
+
+Debian: sudo apt install fzf ripgrep fd sd
+
+qsv is available here: https://github.com/jqnatividad/qsv
+```
+
+If the optional dependencies are missing `denote-fzf-lua` falls back to standard Unix tools.
+
+As a rough benchmark, the Rust tools can perform a search through 10k notes in 0.1s vs. 0.2s for standard tools on my PC. For 100k notes it's 0.6s vs. 2.1s.
+
+`qsv` is used over the smaller, more ubiquitous `xsv` because it can table format very large inputs (e.g. 100k notes) without errors.
+
+# License
+
+GNU AGPL (`fzf-lua` license)