Skip to content

Add 'Used by' section in README.md #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
shenxianpeng opened this issue May 9, 2022 · 8 comments · Fixed by #211
Closed

Add 'Used by' section in README.md #61

shenxianpeng opened this issue May 9, 2022 · 8 comments · Fixed by #211
Labels
documentation Improvements or additions to documentation

Comments

@shenxianpeng
Copy link
Collaborator

shenxianpeng commented May 9, 2022

Since this PR #60 merged, this repo lost all the previous used by links (result is here), how about adding 'Used by' section in README.md? we could:

  • List the most famous projects like google/flatbuffers, others display links or number
  • Or display like contributor avatars as in many projects
@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label May 9, 2022
@2bndy5
Copy link
Collaborator

2bndy5 commented May 9, 2022

In those search results, I'm only seeing the Google/flatbuffers repo worth mentioning. Most of the other projects looked like school projects.

@shenxianpeng
Copy link
Collaborator Author

shenxianpeng commented May 11, 2022

Yes, only google and another one CHIP-SPV/chip-spv. Adding the following badges might encourage more people to use.

Once this repo has more users, we could remove the following badges.

Used By

GitHub Repo stars
GitHub Repo stars

Or

Projects Information
GitHub Repo stars
GitHub Repo stars

@2bndy5
Copy link
Collaborator

2bndy5 commented May 11, 2022

Using badges might confuse people with a status of other projects, but I like the stars count. I also find it a little hard to read the white text on green background.

Maybe something a bit more formal?

Used By

It would be nice if we could have a badge (like the stars count) that shows the total search results.

@shenxianpeng
Copy link
Collaborator Author

I like your revision 👍

Yes, I tried, but I did not find something like this.

It would be nice if we could have a badge (like the stars count) that shows the total search results.

shenxianpeng added a commit that referenced this issue May 11, 2022
shenxianpeng added a commit that referenced this issue May 11, 2022
@shenxianpeng
Copy link
Collaborator Author

shenxianpeng commented Mar 19, 2024

This issue got a little further recently, there is almost no similar tool for generating Used By quantities on the market, so I recently made one (in beta). It can automatically generate a 'Used By' badge, the number is fetched from the https://github.com/cpp-linter/cpp-linter-action/network/dependents page, and creates a pull request when the badge number changes with a GitHub Action. Here is the last Used By badge of cpp-linter-action for example:

Used by

Just wanted to see if there were any thoughts or comments here.

@shenxianpeng shenxianpeng reopened this Mar 19, 2024
@2bndy5
Copy link
Collaborator

2bndy5 commented Mar 19, 2024

What's happening here? I see the link shows:
image
but the badge says 523. Did I misunderstand something?

Otherwise, that is a pretty cool idea! And I like the auto-PR feature.

@2bndy5
Copy link
Collaborator

2bndy5 commented Mar 19, 2024

Oh, 465 users of package cpp-linter/cpp-linter-action + 58 users of package shenxianpeng/cpp-linter-action. So, 465 + 58 = 523.

I'm ok with using that badge. You want to open a PR?

@shenxianpeng
Copy link
Collaborator Author

shenxianpeng commented Mar 20, 2024

465 + 58 = 523.

Correct :) sorry for not mentioning it in my last comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants