README Template - Githubissues

nativescript-community / plugin-seed

The plugin seed used for NativeScript Community plugins.

3 stars 2 forks source link

README Template #4

Open keerl opened 4 years ago

keerl commented 4 years ago

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)