Template for Add On Modules
You should include at least one paragraph on what the module is, the problem it solves, and why it is important. Please don’t describe how you did it or the libraries involved unless those details are important to the problem solved.
Required. How does one go about installing this module? If it’s the default process, just note it. You don’t have to re-include the steps here.
Recommended. How does someone use this module?
Optional. When included, this should note improvements, new features, and bug fixes broken out by version.
Required. This should include a link to where users can file bug reports, feature requests, or get help.
This can optionally describe important limitations or gaps.
Option section for any extra information.