Improve default addon README #7479
Conversation
blueprints/addon/files/README.md
Outdated
| @@ -1,26 +1,47 @@ | |||
| # <%= addonName %> | |||
|
|
|||
There was a problem hiding this comment.
Can this blank line go away?
There was a problem hiding this comment.
It can, I usually use it as padding, but I'm okay if we decided to remove it
There was a problem hiding this comment.
I vote for removal, it looks strange to me.
| Contributing | ||
| ------------------------------------------------------------------------------ | ||
|
|
||
| ### Installation |
There was a problem hiding this comment.
Thoughts on having the Contributing section largely be a cross-link to CONTRIBUTING.md, and moving the guts of this section into that file?
There was a problem hiding this comment.
thought about it, but given the short length and the content not really fitting with what GitHub seems to expect from that file I decided to keep it in here for now.
|
|
||
| For more information on using ember-cli, visit [https://ember-cli.com/](https://ember-cli.com/). | ||
| This project is licensed under the [MIT License](LICENSE.md). |
There was a problem hiding this comment.
This will make a third location that the license of the addon is indicated (package.json & LICENSE.md being the others).
Not sure that I object, but feel it is worth noting.
There was a problem hiding this comment.
Yeah I wouldn't mind removing this section either.
There was a problem hiding this comment.
I would prefer to keep it in for better visibility 🤔
This PR changes the
README.mdthat is generated by default for new addons in a few ways:This is roughly similar to what we've been doing in some of our own addons already, e.g. https://github.com/ember-cli/ember-cli-eslint/blob/master/README.md
Resolves #7278
/cc @offirgolan