A simple PHP based Arduino library badge generator

Make sure to check out ArduBadge from @gilmaimon which is an awesome repo that has done this many years ago, but is recently fallen out of maintenance ( Jul 2024 ). This repo is not really a fork of that project nor does it use the same approach, but it is inspired by it and reults in the same output.

I still invite you to test the ArduBadge repo first, before using this project :D

What is this?

This is a simple PHP based Arduino library badge generator. It generates a badge for your Arduino library by fetching the data from the Arduino website. The code can not be run on github as it does not support PHP, so it is hosted on https://ardubadge.simplefoc.com/

The generation process is simple:

1. The repo gets the name of the library from the url and finds the lates version of the library on the arduino website that matches the name. It parses https://www.arduino.cc/reference/en/libraries/library+name/. The code will cache the library versions and only fetch it once a day.
2. Once it fetched it the code builds a badge based on the github badges.

How to use it?

To use this badge generator, you need to provide the name of the library you want to generate the badge for.

The URL to generate the badge is:

https://ardubadge.simplefoc.com?lib=library+name

The output for the Simple FOC library will be:

How to embed it in your README?

You can embed the badge in your README by using the following markdown code:

![Arduino Library](https://ardubadge.simplefoc.com?lib=library+name)

or using the pure HTML code:

  <img src="https://ardubadge.simplefoc.com?lib=library+name" alt="Arduino Library">

Make sure to put + for empty spaces if your library has some

Contributing

If you want to contribute to this project, feel free to open an issue or a pull request. I'd be happy to see this project grow and become more useful for the community.

Hosting the code yourself

If you want to host the code yourself you can do so by cloning the repo and running it on your server. The code is very simple and does not require any database or any other dependencies. The only thing you need is a PHP server.

In our case we are using a simple Apache server with PHP installed and the code is automatically deployed to the server on every push to the main branch (using webhooks not the github actions).