Add a badge for Hits
Closed this issue ยท 7 comments
Is your feature request related to a problem? Please describe.
A GitHub repository can have a HIT badge rendered on top of the README.md to allow contributors / users to quickly understand know how many people are viewing your GitHub projects!
** Would you be willing to help with a PR? **
[ ] Yes, absolutely
Describe the solution you'd like
This is what the badge should look like in its most basic form:
Hits
It should be accessible as
<HitsBadge username={username} project={project} />.
Since Shields.io has autogenerated license badges: https://img.shields.io/github/license//, perhaps the badge component will default to autogenerated license badges, and can have an optional prop that renders the appropriate license badge based on the license field on package.json.
Additional context
Add any other context or screenshots about the feature request here.
Issue-Label Bot is automatically applying the label feature_request
to this issue, with a confidence of 0.97. Please mark this comment with ๐ or ๐ to give our bot feedback!
Links: app homepage, dashboard and code for this bot.
Hey @dbartholomae .How about this feature
I like it! But please take a prop pkg
and extract username and project from it. You will also have to handle the case where package.json does not contain the information by displaying an empty string. You can look at GithubIssuesBadge as an example.
Please also remember to write a short documentation on what this badge does in the comment in front of the component. I had to look up the webpage to understand it.
<HitsBadge pkg={pkg} />
@Ruchika30 are you still working on this? Otherwise I would open it up on Friday :)
@Ruchika30 are you still working on this? Otherwise I would open it up on Friday :)
Yes @dbartholomae . I ll raise Pr soon
@dbartholomae KIndly review my PR #51
Thanks! Looks good! ๐๐ป
Closed by #51