create-capacitor-plugin icon indicating copy to clipboard operation
create-capacitor-plugin copied to clipboard

Published 20 hours ago • verified publisher icon ionic-team

Create readme when auto Generating an example plugin

Open macdja38 opened this issue 5 years ago • 3 comments

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.

macdja38 avatar Jun 27 '19 21:06 macdja38

I got lost

lisagale avatar Sep 12 '19 14:09 lisagale

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

imhoffd avatar Sep 23 '20 19:09 imhoffd

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

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

distante avatar Feb 10 '21 09:02 distante