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

feat(readme): add author notes to readme #14

Closed
wants to merge 7 commits into from
Closed

feat(readme): add author notes to readme #14

wants to merge 7 commits into from

Conversation

imhoffd
Copy link
Contributor

@imhoffd imhoffd commented Sep 21, 2020

depends on #22
resolves #8

@jcesarmobile
Copy link
Member

I think it should include install instructions like npm install {{{ PACKAGE_NAME }}} and npx cap sync. Also manual android MainActivity.java changes. That's why I didn't add any other information on the PR where I added the README, because it's still unclear if we will manage to skip that part in Capacitor 3

@imhoffd
Copy link
Contributor Author

imhoffd commented Sep 21, 2020

Ah, I was thinking the README could be for the plugin developer at first, and then they'd change it. But thinking about this more, maybe these instructions should be in a separate markdown file and the README could be for what you're describing. 👍

@jcesarmobile
Copy link
Member

Yeah, maybe in a CONTRIBUTING.md

@imhoffd imhoffd changed the title feat(readme): add instructions and links feat(contributing): add instructions and links Oct 23, 2020
@imhoffd imhoffd closed this Oct 23, 2020
@imhoffd imhoffd reopened this Oct 23, 2020
@imhoffd imhoffd changed the title feat(contributing): add instructions and links feat(readme): add author notes to readme Oct 23, 2020
@jcesarmobile
Copy link
Member

I personally don’t like the idea of adding this notes, and also I don’t think it closes #8, that’s about install instructions of the plugin for users.

@imhoffd
Copy link
Contributor Author

imhoffd commented Oct 26, 2020

That's fine. Maybe #8 should be closed because we already have install instructions: https://github.com/ionic-team/create-capacitor-plugin/blob/main/assets/plugin-template/README.md.mustache

@imhoffd imhoffd closed this Oct 26, 2020
@imhoffd imhoffd deleted the readme-2 branch October 26, 2020 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create readme when auto Generating an example plugin
2 participants