badges/poser

Poser, add badges on your readme..

PHP badges poser

This is a php library that creates badges like and and , according to Shields specification., _(*1)

This library is used by https://poser.pugx.org, _(*2)

, _(*3)

Dependencies

• PHP 8.1 or higher
• GD extension

you can still use the library with lower PHP versions, using the old releases, _(*4)

Use as command

1. Create a project

composer create-project badges/poser
ln -s poser/bin/poser /usr/local/bin/poser

2. Launch the command

Create an image, _(*5)

poser license MIT blue -p "license.svg"

Flush an image, _(*6)

poser license MIT blue

Choose a different style, _(*7)

poser license MIT blue -s "for-the-badge"

Usage as library

1. Add to composer dependencies

composer require badges/poser

2. Use in your project as lib

use PUGX\Poser\Render\SvgPlasticRender;
use PUGX\Poser\Poser;

$render = new SvgPlasticRender();
$poser = new Poser([$render]);

echo $poser->generate('license', 'MIT', '428F7E', 'plastic');
// or
echo $poser->generateFromURI('license-MIT-428F7E.svg?style=plastic');
// or
echo $poser->generateFromURI('license-MIT-428F7E?style=plastic');
// or
$image = $poser->generate('license', 'MIT', '428F7E', 'plastic');

echo $image->getStyle();

The allowed styles are: plastic, flat, flat-square, and for-the-badge., _(*8)

Encoding

Dashes -- → - Dash, _(*9)

Underscores __ → _ Underscore, _(*10)

_ or Space → Space, _(*11)

More

For more info please see the behat features and the examples in the php-spec folder, _(*12)

Why a composer badge?

Not only because all the other languages already have it, but having the latest stable release in the readme could save time., _(*13)

Contributing

Active contribution and patches are very welcome.
Please refer to CONTRIBUTING, _(*14)

License

, _(*15)