configuration documentation could be better

[jam1015]

reading through it it is not 100% clear what to do to configure this plugin. for example in the 'Make it Yours' section it is not completely clear what to do with that M objject. In Namu_config.md you have

require("namu").setup({ namu = { options = { ... } } })

not really clearn what namu = ... is. It seems to refer to either the symbols, colorscheme, or ui element eplorers but this isn't clear. my advice is to have one block of code that explicitly has all options. great plugin, and the configuration is figure-outable, but at this moment not 100% transparent to someone who wants to take a glance, copy in the complete default config to their neovim config and fool around with it later.

[bassamsdata]

Thanks a bunch for your feedback! You’re absolutely right about that.

I’ve made a few changes to the readme to include the default values in a clearer way. I hope it’s easier to understand now. Please let me know what you think!

I’m also planning to update the doc with more explanations. I think it’s a bit outdated now, so I want to make sure it’s up-to-date and helpful.