Skip to content
This repository has been archived by the owner. It is now read-only.
A badge generator for Laravel 5.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
resources
src
tests
.gitattributes
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
composer.json
phpunit.xml.dist

README.md

Alt Three Badger

A badge generator for Laravel 5.

Installation

This version requires PHP 7.1 or 7.2, and supports Laravel 5.5 - 5.7 only.

To get the latest version, simply require the project using Composer:

$ composer require alt-three/badger

Once installed, if you are not using automatic package discovery, then you need to register the AltThree\Badger\BadgerServiceProvider service provider in your config/app.php.

Examples

Get started immediately:

// Using the facade
Badger::generate('license', 'MIT', 'blue', 'plastic')

// Dependency injection example
$badger->generate('license', 'MIT', '#ff69b4', 'plastic')

License Blue MIT License Custom MIT

Usage

The generate method takes four parameters:

Badger::generate('license', 'MIT', 'blue', 'flat-square')

The first parameter is the subject, or what it is the badge is showing. In the example above this is the license. The second parameter is the value (the right hand of the badge). Next is the color of the badge. This can be one of the following preset colors or a valid hex string.

  • brightgreen
  • green
  • yellow
  • yellowgreen
  • orange
  • red
  • blue
  • grey
  • lightgray

And finally the fourth parameter is the badge type. This determines the style of the badge and can be one of the four values below.

  • flat-square (default)
  • plastic-flat, flat
  • plastic
  • social (without links)

Security

If you discover a security vulnerability within this package, please e-mail us at support@alt-three.com. All security vulnerabilities will be promptly addressed.

License

Alt Three Badger is licensed under The MIT License (MIT).

Based on the work done at badges/poser.

You can’t perform that action at this time.