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

Add specific instructions for addons in README #6

Open
rajasegar opened this issue Jan 22, 2020 · 5 comments
Open

Add specific instructions for addons in README #6

rajasegar opened this issue Jan 22, 2020 · 5 comments

Comments

@rajasegar
Copy link
Contributor

We may require specific instructions on how to use this blueprint with and without custom options.

Using the blueprint with addons

$ ember addon my-ember-addon
$ cd my-ember-addon
$ ember init -b ember-a11y-blueprint

Using custom language for the blueprint with addons

$ ember addon my-ember-addon
$ cd my-ember-addon
$ ember init -b ember-a11y-blueprint --lang=es
@kellyselden
Copy link
Owner

Do addons need special instructions compared to apps? I don't see the need.

@rajasegar
Copy link
Contributor Author

I have a doubt here then, why are we creating an addon and then applying the blueprint with init. Can't we create an addon with the blueprint in the first place itself?

$ ember addon my-ember-addon -b ember-a11y-blueprint

@kellyselden
Copy link
Owner

This is intended to be a partial blueprint as described by emberjs/rfcs#477. It "decorates" a normal app blueprint with extras. This is why the blueprint is mostly empty.

@kellyselden
Copy link
Owner

There may be a better way to "inherit" the default index.html without keeping a complete copy in sync.

@rajasegar
Copy link
Contributor Author

I personally prefer both types of blueprints, one full-blown blueprint for starting new ember projects with first-class a11y support and one partial blueprint to update existing apps to support recommended a11y standards. And if we figure out the best way to inherit the default blueprint I think we can solve both the above use-cases.

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

No branches or pull requests

2 participants