continuous-reforestation icon indicating copy to clipboard operation
continuous-reforestation copied to clipboard

Tree Badge for your README

Open Ly0n opened this issue 3 years ago • 4 comments

Projects want to show how many trees they have already planted. This could be done with a badge that uses the API.

Ly0n avatar Feb 21 '21 11:02 Ly0n

I implemented https://github.com/marketplace/actions/bring-your-own-badge on the repo to test it out.

The problem is that it will create another branch to store the JSON endpoint for the badge. I think most people don't want this as it also creates another push for the repository for each push.

We could also create a badge with some trees just saying something like "Reforestation States" and then link it to the dashboard that is public.

https://badgen.net/ could help us here and we can create our own logo for that.

What is your opinion? @tjarkdoering @cjscheller

Ly0n avatar Mar 17 '21 19:03 Ly0n

Glad you were able to implement that badge in the repo. I personally don’t think it’s terrible to have a separate branch and push dedicated to updating the JSON endpoint, but I know that is just me and some people will feel differently.

Could you possibly make it optional to use the badge with this method?

The problem with the “Reforestation States” badge and using the public dashboard is that we are planning to deprecate that dashboard in the near future in favor of the new dashboard we are rolling out. It does sound like the best final iteration of this badge will just fetch from the DigitalHumani API, but I don’t think we’re ready to support that quite yet. So while we work towards that, do you feel like the JSON badge option is good enough for now?

Let me know your thoughts

cjscheller avatar Mar 18 '21 05:03 cjscheller

@cjscheller

Could you possibly make it optional to use the badge with this method?

@tjarkdoering and I tested the bring-your-own-badge independently and it does also not work reliable for both of us. Maybe it is better to do the release without the badge for now and add it later.

Ly0n avatar Mar 20 '21 12:03 Ly0n

Totally cool with this

cjscheller avatar Mar 22 '21 04:03 cjscheller