Improve documentation (suggestions welcome)

[cseickel]

Basic usage is OK, but we need much better documentation on how to customize Neo-tree. I think the wiki is the place for this.

Things to document include:

• Basic overview of all the ways it can be customized, with example use cases for each one
• List all built-in components along with their config options
• Full explanation of components and renderers
• Full explanation of mappings to custom functions (or defining commands)
• Full explanation of events (the vim doc is pretty good, maybe just copy to the wiki)
• Add some Recipes for custom components
• Add some Recipes for mapping to a custom function
• Add some recipes for event_handler usage
• LINK TO THE WIKI IN THE README!
• Remove README in lua/sources/filesystem, it's just a maintenance problem

If there is anything else you feel needs to be added or have any ideas at all on this subject, please add a comment. Also, if anything here seems like a particular priority, let me know what you think that order should be.

[levouh]

I think using md2vim would make this super easy, as you get "viewable" markdown files for those using the web, and direct translation into Vim help docs with zero effort.

[cseickel]

I think that is a great idea @levouh !