From 21417212f640a1dad28a1408f04468819848f5e7 Mon Sep 17 00:00:00 2001 From: Alexander Courtis Date: Sat, 7 Dec 2024 14:28:12 +1100 Subject: [PATCH] docs(#516): README: full description (#517) * doc(#516): README: full description * doc(#516): README: full description --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ec4b5959..1922f906 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,22 @@ Nvim-web-devicons requires version 2.3 or above to work properly. If you are una # Nvim-web-devicons -A `lua` fork of [vim-devicons](https://github.com/ryanoasis/vim-devicons). This plugin provides the same icons _as well as_ colors for each icon. +Provides [Nerd Font](https://www.nerdfonts.com/) [1] icons (glyphs) for use by neovim plugins: +- Icons by: + - Extension + - Full name +- Colours +- Light and dark variants +- API to modify/add icons -Light and dark color variants are provided. +A `lua` fork of [vim-devicons](https://github.com/ryanoasis/vim-devicons). + +[1] Not limited to Nerd Font icons: unicode and other fonts may be used. ## Requirements - [neovim >=0.7.0](https://github.com/neovim/neovim/wiki/Installing-Neovim) -- [A patched font](https://www.nerdfonts.com/) +- [A Patched Nerd Font](https://www.nerdfonts.com/) ## Installation