Improve documentation with default lua settings

[eshepelyuk]

Hello @TaDaa

Found this plugin via your reply on Reddit. This is great that you keep maintaining this very usueful functionality. Installed it today and all works fine with default settings.

Although I would like to raise an documentation issue regarding configuration, since I found current state of docs a bit messy, comparing to other NeoVim plugins.

Usually plugins are providing a list of all lua parameters with their default values as lua code snippet, example from similar plugins

• https://github.com/miversen33/sunglasses.nvim?tab=readme-ov-file#configuration
• https://github.com/levouh/tint.nvim?tab=readme-ov-file#gear-setup

Or from some other plugins

• https://github.com/lewis6991/gitsigns.nvim?tab=readme-ov-file#installation--usage
• https://github.com/nvim-lualine/lualine.nvim?tab=readme-ov-file#usage-and-customization

It would be great if you could adjust docs' NeoVIm section to provide similar lua code snippet.

[TaDaa]

That's a great point @eshepelyuk !

I'll make sure this gets added back into the docs later today :)

[TaDaa]

meant related not fixed, there is definitely more cleanup to be done on the docs