Skip to content

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

Merged
merged 2 commits into from
Feb 26, 2019
Merged

chore(readme): update styles and information #1685

merged 2 commits into from
Feb 26, 2019

Conversation

hiroppy
Copy link
Member

@hiroppy hiroppy commented Feb 22, 2019

  • This is a bugfix
  • This is a feature
  • This is a code refactor
  • This is a test update
  • This is a docs update
  • This is a metadata update

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

@codecov
Copy link

codecov bot commented Feb 22, 2019

Codecov Report

Merging #1685 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 419f02e...c0075e9. Read the comment docs.

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

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

Copy link
Member Author

@hiroppy hiroppy Feb 25, 2019

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?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hiroppy yep L21

@hiroppy
Copy link
Member Author

hiroppy commented Feb 26, 2019

updated

Copy link
Member

@alexander-akait alexander-akait left a 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.

@hiroppy
Copy link
Member Author

hiroppy commented Feb 26, 2019

updated

Copy link
Member

@alexander-akait alexander-akait left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job thanks!

@alexander-akait alexander-akait merged commit cb10f83 into webpack:master Feb 26, 2019
@hiroppy hiroppy deleted the feature/update-readme branch February 26, 2019 11:07
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.

3 participants