Skip to content

Commit 1846130

Browse files
committed
docs: update help docs
1 parent a9f5a1e commit 1846130

File tree

1 file changed

+6
-28
lines changed

1 file changed

+6
-28
lines changed

doc/utils.txt

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ SETUP *utils-setup*
2727

2828
REQUIREMENTS ~
2929

30-
- Latest version of `neovim`
3130
- `plenary.nvim`
31+
- `nvim-web-devicons` (optional, for language icons)
3232

3333

3434
INSTALLATION ~
@@ -45,35 +45,12 @@ If you are building a plugin that requires the utilities provided by
4545
'yourname/plugin.nvim',
4646
dependencies = {
4747
'2kabhishek/utils.nvim'
48-
},
49-
},
50-
<
51-
52-
53-
CONFIGURATION
54-
55-
`utils.nvim` can optionally be configured by specifying `opts` with Lazy or
56-
alternatively with the `setup` function like so:
57-
58-
>lua
59-
-- Lazy opts:
60-
{
61-
'yourname/plugin.nvim',
62-
dependencies = {
63-
{
64-
'2kabhishek/utils.nvim',
65-
opts = {
66-
-- 'telescope', 'fzf_lua', or 'snacks' (default)
67-
picker_provider = "snacks",
68-
}
48+
opts = {
49+
-- Decide picker is used by default
50+
picker_provider = "snacks", -- 'telescope', 'fzf_lua', or 'snacks' (default)
6951
}
7052
},
71-
}
72-
73-
-- using `setup` function:
74-
require("utils").setup({
75-
picker_provider = "telescope"
76-
})
53+
},
7754
<
7855

7956

@@ -88,6 +65,7 @@ functionalities:
8865
- `picker`a module providing abstractions over various picker providers, supports `telescope`, `fzf_lua`, and `snacks`.
8966
- `cache`a module for caching data and managing cache files.
9067
- `notification`a module for simplifying notification queues.
68+
- `language`a module for programming language filetype and icon management.
9169
- `shell`a module for executing shell commands and opening URLs, files.
9270
- `json`a module for handling JSON data.
9371
- `time`a module for working with time and date.

0 commit comments

Comments
 (0)