Fix various details in README.md #335
Merged
Conversation
This file contains hidden or 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
Add newline after heading and code block (consistency). Use triple backticks for bash code examples. Change how library will be installed via composer. Remove explicit version constraint in `composer require` example. Recent versions of composer will default the most recent version and set a non-major breaking constraint. Version constraint was still pointing to the most recent version of 2.* release. Soft limit text to 80 chars (does node affect code examples). Remove 'Basic usage' heading. Fix heading 'Type coercion' (space and typo). Add missing opening PHP tag (section 'Type coercion'. Fix indentation in code example (consistent 4 spaces). Use single backticks for inline code. Add parenthesis to method in description.
|
Btw, it took me longer to document the changes in the commit message than changing in the source... 😄 |
bighappyface
approved these changes
Nov 26, 2016
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.
Add newline after heading and code block (consistency).
Use triple backticks for bash code examples.
Change how library will be installed via composer.
Remove explicit version constraint in
composer requireexample. Recentversions of composer will default the most recent version and
set a non-major breaking constraint.
Version constraint was still pointing to the most recent version of 2.*
release.
Soft limit text to 80 chars (does node affect code examples).
Remove 'Basic usage' heading.
Fix heading 'Type coercion' (space and typo).
Add missing opening PHP tag (section 'Type coercion'.
Fix indentation in code example (consistent 4 spaces).
Use single backticks for inline code.
Add parenthesis to method in description.