diff --git a/README.md b/README.md index 63f5865..d66a88f 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ options in the functions. Customization will be done entirely using a separate - [Installation](#installation) - [Configuration](#configuration) - [Advanced configuration](#advanced-configuration) -- [Similar projects](#similar-projects) +- [Alternative and related projects](#alternative-and-related-projects) ## Requirements @@ -205,6 +205,7 @@ require('dressing').setup({ ``` ## Advanced configuration + For each of the `input` and `select` configs, there is an option `get_config`. This can be a function that accepts the `opts` parameter that is passed in to `vim.select` or `vim.input`. It must return either `nil` (to @@ -212,6 +213,7 @@ no-op) or config values to use in place of the global config values for that module. For example, if you want to use a specific configuration for code actions: + ```lua require('dressing').setup({ select = { @@ -230,8 +232,11 @@ require('dressing').setup({ }) ``` -## Similar projects +## Alternative and related projects + +- [telescope-ui-select](https://github.com/nvim-telescope/telescope-ui-select.nvim) - provides a `vim.ui.select` implementation for telescope +- [nvim-fzy](https://github.com/mfussenegger/nvim-fzy) - fzf alternative that also provides a `vim.ui.select` implementation ([#13](https://github.com/mfussenegger/nvim-fzy/pull/13)) - [nvim-notify](https://github.com/rcarriga/nvim-notify) - doing pretty much the same thing but for `vim.notify` - [nui.nvim](https://github.com/MunifTanjim/nui.nvim) - provides common UI