Skip to content

Commit

Permalink
Document devicons and mini.icons as optional deps
Browse files Browse the repository at this point in the history
  • Loading branch information
julienvincent committed Jul 23, 2024
1 parent f062623 commit 8a188f6
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,18 @@ the `right` directory if no output is provided) to match your selection.
config = function()
require("hunk").setup()
end,
dependencies = {
{ "MunifTanjim/nui.nvim" }
}
}
```

### Dependencies

+ [nui.nvim](https://github.com/MunifTanjim/nui.nvim)
+ [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons) (optional)
+ [mini.icons](https://github.com/echasnovski/mini.icons) (optional)

If you want file type icons in the file tree then you should have one of either `mini.icons` or `nvim-web-devicons`
installed. Otherwise, neither are required.

## Configuration

```lua
Expand Down

0 comments on commit 8a188f6

Please sign in to comment.