refactor: update readme with modern style and convention #100
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- npmjs.org now left-aligns all content except images by default; aligns section headers left - removes maintainers section: rarely kept up to date across the org - simplifies the Examples section, replaces lorem with [ placeholder ] - adds License section to point to LICENSE file for convenience - refactors the Options sections with simpler layout and easier to read modern convention - adds package name header - moves badges below the webpack logo - uses github asset for webpack logo - adds Requirements section - replaces Usage with Getting Started and friendly text, direction - removed unnecessary multiple, copied Examples and Options
joshwiens
approved these changes
Mar 31, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
aligns section headers left
read modern convention