PHP badges poser

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

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

, _(*3)

Dependencies

PHP 5.3 or higher
GD extension

Use as command

1. Create a project

``` bash $ composer create-project badges/poser ~1.2 $ ln -s poser/bin/poser /usr/local/bin/poser, _(*4)


#### 2. Launch 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 badges/poser ~1.2`

#### 2. Use in your project as lib

``` php
    use PUGX\Poser\Render\SvgRender;
    use PUGX\Poser\Poser;

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

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

    echo $image->getFormat();

Encoding

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

Underscores __ → _ Underscore, _(*6)

_ or Space → Space, _(*7)

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

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 :), _(*9)

First fork or clone the repository

git clone git://github.com/badges/poser.git
cd poser

Install vendors:

``` bash composer install, _(*10)


- Run specs:

``` bash
./bin/phpspec run --format=pretty

Then run behat:

``` bash ./bin/behat, _(*11)


## Using Docker

We provide a `docker-compose.yml.dist` file to allow you to run tests in a Docker container.

```bash
cp docker-compose.yml.dist docker-compose.yml
docker-compose up -d
docker-compose exec fpm composer update
docker-compose exec fpm bin/phpspec run --format=pretty
docker-compose exec fpm bin/behat

The provided Docker compose file is for a PHP 7.1 environment, but you can modifiy it to use PHP 5.6., _(*12)

See https://store.docker.com/community/images/jmleroux/fpm/tags, _(*13)