NAME
Pod::Weaver::Section::Badges - Add (or append) a section with badges
VERSION
Version 0.0202, released 2015-03-23.
SYNOPSIS
; in weaver.ini
[Badges]
section = BUILD STATUS
formats = html
badge = Travis
badge = Gratipay
-travis_user = MyGithubUser
-travis_repo = the_repository
-travis_branch = master
-gratipay_user = ExampleNameDESCRIPTION
This inserts a section with status badges. The configuration in the synopsis would produce something similar to this:
=head1 BUILD STATUS
=begin HTML
<p>
<a href="https://travis-ci.org/MyGithubUser/the_repository"><img src="https://travis-ci.org/MyGithubUser/the_repository.svg?branch=master" /></a>
<img src="https://img.shields.io/gratipay/ExampleName.svg" />
</p>
=end HTMLThis module uses badges in the Badge::Depot::Plugin namespace. See Task::Badge::Depot for a list of available badges. The synopsis uses the Badge::Depot::Plugin::Travis and Badge::Depot::Plugin::Gratipay badges.
ATTRIBUTES
formats
| ArrayRef [ Enum [ "html","markdown" ] ] | required | read-only |
The formats to render the badges for. Comma separated list, not multiple rows.
badge
| ArrayRef [ Str ] | optional, default: []
|
read-only |
The name of the wanted badge, lowercased. Repeat for multiple badges. The name is everything after 'Badge::Depot::Plugin::'.
badge_args
| HashRef [ Str ] | optional, default: {}
|
read-only |
badge_args is not a usable attribute in itself: All settings for badge plugins start with a dash, followed by the badge name (lowercased) and an underscore. If the badge plugin is Badge::Depot::Plugin::Travis, then all settings start with '-travis_'.
main_module_only
| Bool | optional, default: 1
|
read-only |
If true, the badges will only be inserted in the main module (as defined by Dist::Zilla). If false, they will be included in all modules.
section
| Str | optional, default: NAME
|
read-only |
The section of pod to add the badges to, identified by its heading. The section will be created if it doesn't already exist.
SEE ALSO
BADGES
SOURCE
https://github.com/Csson/p5-Pod-Weaver-Section-Badges
HOMEPAGE
https://metacpan.org/release/Pod-Weaver-Section-Badges
AUTHOR
Erik Carlsson <info@code301.com>
COPYRIGHT AND LICENSE
This software is copyright (c) 2015 by Erik Carlsson <info@code301.com>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.