Skip to content

Commit 9d6f6d0

Browse files
committed
docs: cleanup readme
1 parent 4e9717b commit 9d6f6d0

1 file changed

Lines changed: 6 additions & 26 deletions

File tree

README.md

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@
3838

3939
### ⚙️ Requirements
4040

41-
- Latest version of `neovim`
4241
- `plenary.nvim`
42+
- `nvim-web-devicons` (optional, for language icons)
4343

4444
### 💻 Installation
4545

@@ -53,33 +53,12 @@ If you are building a plugin that requires the utilities provided by `utils.nvim
5353
'yourname/plugin.nvim',
5454
dependencies = {
5555
'2kabhishek/utils.nvim'
56-
},
57-
},
58-
```
59-
60-
#### ⚙️ Configuration
61-
62-
`utils.nvim` can optionally be configured by specifying `opts` with Lazy or alternatively with the `setup` function like so:
63-
64-
```lua
65-
-- Lazy opts:
66-
{
67-
'yourname/plugin.nvim',
68-
dependencies = {
69-
{
70-
'2kabhishek/utils.nvim',
71-
opts = {
72-
-- 'telescope', 'fzf_lua', or 'snacks' (default)
73-
picker_provider = "snacks",
74-
}
56+
opts = {
57+
-- Decide picker is used by default
58+
picker_provider = "snacks", -- 'telescope', 'fzf_lua', or 'snacks' (default)
7559
}
7660
},
77-
}
78-
79-
-- using `setup` function:
80-
require("utils").setup({
81-
picker_provider = "telescope"
82-
})
61+
},
8362
```
8463

8564
## 🚀 Usage
@@ -91,6 +70,7 @@ require("utils").setup({
9170
- `picker`: a module providing abstractions over various picker providers, supports `telescope`, `fzf_lua`, and `snacks`.
9271
- `cache`: a module for caching data and managing cache files.
9372
- `notification`: a module for simplifying notification queues.
73+
- `language`: a module for programming language filetype and icon management.
9474
- `shell`: a module for executing shell commands and opening URLs, files.
9575
- `json`: a module for handling JSON data.
9676
- `time`: a module for working with time and date.

0 commit comments

Comments
 (0)