docs(#516): README: full description

[alex-courtis]

fixes #516

[hasecilu]

Also would be good to update the About and add mote tags, maybe: icons, neovim, lua, plugin

[alex-courtis]

Great idea!

How does that look?

[Oneechan69]

@alex-courtis So far it looks good, but does the plugin provide all nerd font icons and overrides? If not then I think the readme should state that.

[alex-courtis]

@alex-courtis So far it looks good, but does the plugin provide all nerd font icons and overrides? If not then I think the readme should state that.

Maybe some better phrasing.

The icons it provides by default are a subset of nerd fonts. You can override with whatever you please.

Proposed about:

Provides icons (glyphs) for use by neovim plugins. Nerd Font icons are provided for a set of file extensions and names.

[hasecilu]

Provides Nerd Font¹ icons (glyphs) associations with filetypes for use by Neovim plugins.

Footnotes

1. Not limited to use Nerd Font icons, there is even a Unicode glyph used, even there are people that have custom fonts ↩

[hasecilu]

@alex-courtis So far it looks good, but does the plugin provide all nerd font icons and overrides? If not then I think the readme should state that.

I don't think that's important, I think it's evident that not all filetypes and filenames will be covered, certainly is desirable. Not even Nerd Fonts has a list of filetypes/filenames they "just" gather the fonts, actually this project is one of the most complete projects with icons associations and to really achieve the "complete set of overrides" would be needed the help of lot of people, meanwhile I have a small change in progress.

[alex-courtis]

Updated. Many thanks!