Skip to content

PeterDaveHello/poser

 
 

Repository files navigation

PHP badges poser

This is a php library that creates badges like badge-poser and I'm a badge and dark, according to Shields specification.

This library is used by https://poser.pugx.org

Latest Stable Version Latest Unstable Version Total Downloads

Use as command

1. Create a project

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

2. lunch the command

Create an image

$ poser license MIT blue -p "license.svg"

Flush an image

$ poser license MIT blue

Usage as library

1. Add to composer

composer require badge/poser ~0.1

2. Use in your project as lib

    use PUGX\Poser\Render\SvgRender;
    use PUGX\Poser\Poser;

    $render = new SvgRender();
    $poser = new Poser(array($render));

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

    echo $image->getFormat();

Encoding

Dashes --- Dash

Underscores ___ Underscore

_ or Space → Space

More

For more info please see the behat features and the examples in the php-spec folder

Contribution

Active contribution and patches are very welcome. See the github issues. To keep things in shape we have quite a bunch of examples and features. If you're submitting pull requests please make sure that they are still passing and if you add functionality please take a look at the coverage as well it should be pretty high :)

  • First fork or clone the repository
git clone git:https://github.com/badges/poser.git
cd poser
  • Install vendors:
composer install
  • Run specs:
./bin/phpspec run --format=pretty
  • Then run behat:
./bin/behat run

License

License

Releases

No releases published

Packages

No packages published