Skip to content

Commit 4fc505a

Browse files
authored
docs: add nerd font compatibility tag information (#638)
1 parent 8069e89 commit 4fc505a

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,20 @@ Provides [Nerd Font](https://www.nerdfonts.com/) [^1] icons (glyphs) for use by
1212
A `lua` fork of [vim-devicons](https://github.com/ryanoasis/vim-devicons).
1313

1414
> [!TIP]
15-
> nvim-web-devicons adds new icons as they are introduced to Nerd Fonts. Please ensure that you are using the latest version of the font as newly introduced icons may display incorrectly or as an "unknown character".
15+
> nvim-web-devicons is a rolling release, adding new icons as they are introduced to Nerd Fonts. Please ensure that you are using the latest version of the font as newly introduced icons may display incorrectly or as an "unknown character".
1616
1717
> [!IMPORTANT]
18-
> Nerd fonts moved some symbols with version 3.0. Version 2.3 is meant for transition,
19-
> supporting both version 2 and version 3 icons.
20-
> Nvim-web-devicons requires version 2.3 or above to work properly. If you are unable to update
21-
> please use your plugin manager to pin version of nvim-web-dev icons to `nerd-v2-compat` tag.
18+
> Nerd fonts has introduced some breaking changes with the following releases.
19+
> Please use your plugin manager to pin nvim-web-devicons to the compatibility tag, for use with earlier Nerd Font versions.
20+
> - `3.3`: `nerd-v3.2-compat`
21+
> - `3.0`: `nerd-v2-compat`
2222
2323
[^1]: Not limited to Nerd Font icons: unicode and other fonts may be used.
2424

2525
## Requirements
2626

2727
- [neovim >=0.7.0](https://github.com/neovim/neovim/wiki/Installing-Neovim)
28-
- [A Patched Nerd Font](https://www.nerdfonts.com/)
28+
- [A Patched Nerd Font](https://www.nerdfonts.com/) >= 3.3
2929

3030
## Installation
3131

0 commit comments

Comments
 (0)