readme.md

Badges

Installation

To install through composer include the package in your composer.json.

"midnite81/badges": "^1.0.0"

Run composer install or composer update to download the dependencies or you can
run composer require midnite81/badges.

Badges Supported

Type

Example

Latest Stable

Total Downloads

Latest Unstable

Licence

Build

Coverage

Gitter

StyleCI

(Image Coming soon)

Scrutinizer

(Image Coming soon)

Over time support for other badges will be added. You can create your own templates which extend
Midnite81\Badges\Type\BadgeType and can be passed through the $badges->get(MyClass::class) method. More
documentation on adding your own templates will be added later.

Example Usage

Firstly, you need to create an instance of badges.

useMidnite81\Badges\Badges;$badges=newBadges($attributes);// or $badges=Badges::create($attributes);

You'll notice that a variable of $attributes is passed on construction. The attributes are what the package will use
to translate the template. By default we're only going to pass the following attributes as they are needed for the
supported badges. Obviously update the above attributes to suit your own needs.