There should be a standard README template used for all community plugins so everyone has the exact same experience with any plugin.
Here is a list of things that should be included in it:
- Name
- Description
- NPM Badges
- Platform & Framework Badges (iOS, Android, Angular, Vue, Svelte, React)
- GIFs (preferred) or Screenshots
- Table of Contents
- Installation
- Configuration
- API
- Usage
- Running Demos
- Contributions (w/ a link to the GitHub Project)
There should be a standard README template used for all community plugins so everyone has the exact same experience with any plugin.
Here is a list of things that should be included in it: