-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
chore(readme): update styles and information #1685
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
chore(readme): update styles and information #1685
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1685 +/- ##
=======================================
Coverage 83.76% 83.76%
=======================================
Files 8 8
Lines 536 536
Branches 161 161
=======================================
Hits 449 449
Misses 70 70
Partials 17 17 Continue to review full report at Codecov.
|
README.md
Outdated
@@ -30,7 +31,7 @@ fast in-memory access to the webpack assets. | |||
7. [Attribution](#attribution) | |||
8. [License](#license) | |||
|
|||
## Getting Started | |||
<h2 align="center">Getting Started</h2> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should avoid using html
, it is bad practice. Also let's do:
- Remove
Maintainers
section (it is outdated) and no need - Don't move
div
after description
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Don't move
div
after description
sorry, I want to get more details.
Maybe, L21?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hiroppy yep L21
updated |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's avoid using html
in headers, it is really bad idea, when you want compile markdown
to html and publish this on site, it is headache. Better never use html
in markdown, expect when you do something difficult.
updated |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good job thanks!
For Bugs and Features; did you add new tests?
no
Motivation / Use-Case
Change to the same style as webpack's readme.
Breaking Changes
no
Additional Info