Replace website version details with a badge #149
Merged
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.
PR Details
What kind of change does this PR introduce?
This PR introduces changes to represent the version of ML5 using a badge from Shields.io (see all templates here) instead of a hardcoded version number. This helps make it easier to release new versions of the library because we no longer need to manually update the website after every release.
Typically, the process for updating the version would be to:
After these changes are merged, no steps will be required to update the website!
The tradeoff here is that we no longer show the most recent release date because Shields.io, unfortunately, doesn't handle versions for NPM releases. We could set this up later if we ever support GitHub release, though (see GitHub templates here).
Does this PR introduce a breaking change?
Nope! Though there are some cleanup changes included in this PR to remove unused fields.
What needs to be documented once your changes are merged?
I don't believe that there are any necessary documentation changes.
Images
Before
After