It would be nice to script/automate the creation of the README.
There are two main parts of the current README:
- The example section, that shows example usage of the plugin. This example code is now part of
examples/ in the source, and the script could just lift that code and write it to the README file since it's already going to be maintained as an example usage to quickly test the plugin.
- Documenting the options to the plugin. It would be helpful and nice to use code comments on the options structure to be able to generate this section of the README. Perhaps using jsdoc3 or something similar?
It would be nice to script/automate the creation of the README.
There are two main parts of the current README:
examples/in the source, and the script could just lift that code and write it to the README file since it's already going to be maintained as an example usage to quickly test the plugin.