Skip to content

Commit

Permalink
docs(#516): README: full description (#517)
Browse files Browse the repository at this point in the history
* doc(#516): README: full description

* doc(#516): README: full description
  • Loading branch information
alex-courtis authored Dec 7, 2024
1 parent 203da76 commit 2141721
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/) <sup>[1]</sup> 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).

<sup>[1]</sup> 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

Expand Down

0 comments on commit 2141721

Please sign in to comment.