search

ionic-team / create-capacitor-plugin

Create a new Capacitor plugin ⚡️
Other
74 stars 11 forks source link

Create readme when auto Generating an example plugin #8

Open macdja38 opened 5 years ago

macdja38 commented 5 years ago

It would be nice when using the plugin generator if a readme with the instructions on how to install the plugin that was created.

Create react app does a decent job of this when you use it to bootstrap a react project. https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md

Most importantly this should include the install steps for the the npm package as well as npx cap sync etc.

It'd be cool if this went a step further and automatically populated the package name in the install command, seeing as the user is asked to give that on plugin creation.

lisagale commented 5 years ago

I got lost

imhoffd commented 3 years ago

Related: https://github.com/ionic-team/create-capacitor-plugin/issues/15

distante commented 3 years ago

Maybe this also related: https://github.com/ionic-team/capacitor/discussions/3605#discussioncomment-346495

although, it could just be my inexperience with android configuration.