summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTJ DeVries <devries.timothyj@gmail.com>2020-10-19 22:46:36 -0400
committerTJ DeVries <devries.timothyj@gmail.com>2020-10-19 22:46:36 -0400
commitf95fe484f744426f0e192d6aa61cd27aedeaf15a (patch)
treedb0e39d847f33e977ae439d35bfbd8bda115f357 /README.md
parent4cfab37541937cc4b5dac26277b799f7eaabdf1f (diff)
feat: Add ability to configure default sorters
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index 771f7c7..086cdd9 100644
--- a/README.md
+++ b/README.md
@@ -115,12 +115,21 @@ nnoremap <Leader>en <cmd>lua require'telescope.builtin'.find_files{ cwd = "~/.co
Find all the files in your nvim config.
+### Available keys for `defaults`
+
+- `generic_sorter`:
+ - Description: The sorter to be used for generic searches.
+ - `default`: `require('telescope.sorters').get_generic_fuzzy_sorter
+- `file_sorter`:
+ - Description: The sorter to be used for file based searches.
+ - `default`: `require('telescope.sorters').get_fuzzy_file
+
### Full Example
```vim
lua <<EOF
-- totally optional to use setup
-require('telescope').setup{
+require('telescope').setup {
defaults = {
shorten_path = false -- currently the default value is true
}