As a developer, I want web components to be documented
Web components should be well documented with a README.md file in the specific component's root folder.
Example on a README.md-file:
<my-component>
A web component that represents...
Attributes
anattribute
Description of the attribute.
Default value: the default value
Events
| Event Name | Fired When |
|---|---|
theevent |
Something happens |
thesecondevent |
Something else happens |
Example
<my-component></my-component>Edited by Johan Leitet