Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create readme when auto Generating an example plugin #8

Open
macdja38 opened this issue Jun 27, 2019 · 3 comments
Open

Create readme when auto Generating an example plugin #8

macdja38 opened this issue Jun 27, 2019 · 3 comments
Labels
enhancement New feature or request

Comments

@macdja38
Copy link

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
Copy link

I got lost

@jcesarmobile jcesarmobile transferred this issue from ionic-team/capacitor Sep 10, 2020
@jcesarmobile jcesarmobile reopened this Sep 10, 2020
@jcesarmobile jcesarmobile added the enhancement New feature or request label Sep 10, 2020
@imhoffd
Copy link
Contributor

imhoffd commented Sep 23, 2020

Related: #15

@distante
Copy link

Maybe this also related: ionic-team/capacitor#3605 (comment)

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants