nativescript-community / nativescript-community/plugin-seed
README Template
Open
@keerl is already working on this.
Since Nov 8, 2020.
enhancement
- Dominant language
- TypeScript
- Stars
- 3
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
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
- Angular
- Vue
- Svelte
- React
- Running Demos
- Contributions (w/ a link to the GitHub Project)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.