fix: badge syntax and samples in readme #12
Closed
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
|
Hi thanks for PR but badges keep working. Also since badge links are one time only, I prefer to keep them in footer. Focusing on writing docs from top. |
|
Ohh, I found it by googling that there are ways to define link attributes afterwards in markdown! Now I see all your intention. Everything is fine, so let me close this PR. 👏 |
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.
I found that badges in README are not rendered correctly in NPM and GitHub, and that sample URLS are a little too far away from where they are supposed to be used and rendered unnecessarily.
This PR is to fix the badge syntax and comment out sample URLS near the badges.