It has become a commonplace for open-source projects to have in their README a set of badges, providing attention grabbing information about their version, test coverage and other state information.
But these badges are static, ABeamer allows to generate animated badges with remarkable simplicity. ABeamer has an animated badge example in its gallery for quite a while, but since the release of version 1.0.0, the first production level version, these badges have a complete set of configurable parameters, including size, colors and duration.
Also, since this version, is no longer required to have js/css/ini files installed in the local machine, it can be executed from a remote link.
All is required, are the common tools installed in many develop machines:
To see an animated badge in action:
To generate an animated gif from that animation, follow these steps:
The above command line, will create a png file sequence on a newly create folder
Unlike, other JS/CSS animation libraries, ABeamer library is designed to ensure that no frame is lost.
--dp, will delete previous frames, useful when multiple badges need to be generated.
From the png file sequence, to generate the animated gif, all is needed is:
And voila! The gif is created!
To configure the parameters, add them as on the command line as:
The following parameters, and their default values, are supported:
Therefore, to generate a badge of the number of downloads:
Setup a cloud render server
If you want to setup your own cloud render server, it’s advisable to run the js/css/ini file from a local machine.
All that is required is to execute:
Overwrite the css/js/ini files from the following zip.
And just replace the
--url with location point to the