Skip to content
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

[docs] API & Parameter usage #1481

Open
jhk0530 opened this issue Sep 9, 2023 · 1 comment
Open

[docs] API & Parameter usage #1481

jhk0530 opened this issue Sep 9, 2023 · 1 comment

Comments

@jhk0530
Copy link

jhk0530 commented Sep 9, 2023

Hi, thanks for nice app.

I explored api and summarized parameter from apps/api/internal/api/image/params.go

Any comments are appreciated.

I think add to readme.md will be helpful for newbie users like me

Parameter description

Name Type Description
repo Character required
max Integer number of max contributors. Default is 100
columns Integer number of columns for icons. Default is 12
anon Bool whether to include Bots like github-actions[bot]. Default is false
preview Bool Don't know how this work
Via String Don't know how this work, Possible value is unknown, github, preview

Usage

multiple parameter can be used with &

  • Basic (Default) : https://contrib.rocks/image?repo=lacolaco/contributors-img

  • max: https://contrib.rocks/image?repo=lacolaco/contributors-img&max=2

  • columns: https://contrib.rocks/image?repo=lacolaco/contributors-img&columns=1

  • anon: https://contrib.rocks/image?repo=statgarten/door&anon=true

https://contrib.rocks/image?repo=statgarten/door&anon=false

I changed example since this repo doesn't work with anon

3rd contribution is github-actions[bot]

Thanks.

Kim

@jhk0530
Copy link
Author

jhk0530 commented Sep 9, 2023

I missed this one 🥲

스크린샷 2023-09-09 오후 10 49 24

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

No branches or pull requests

1 participant