docs: fix broken download badge link and grammar typo - #5530
Open
electrohyun wants to merge 1 commit into
Open
Conversation
The download badge in the README had a duplicated opening parenthesis, which broke the link. Also fixed "built on top on" to "built on top of" in the package descriptions in the contributing guide.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The kind of change this PR does introduce
Current behavior
The "Downloads per month" badge in
README.mdhas a duplicated opening parenthesis (]((), which breaks the Markdown link so it does not point to the npm package page.The package table in
CONTRIBUTING.mddescribessocket.ioandsocket.io-clientas "built on top on the ... package", which is grammatically incorrect.New behavior
The badge link is well-formed and points to the npm package page.
The two package descriptions read "built on top of the ... package".
Other information (e.g. related issues)
No related issue