-
-
02 Mar 2022 02:43:28 UTC
- Distribution: Dist-Zilla-Plugin-GitHubREADME-Badge
- Module version: 0.35
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues
- Testers (334 / 0 / 5)
- Kwalitee
Bus factor: 1- 83.33% Coverage
- License: perl_5
- Perl: v5.14.0
- Activity
24 month- Tools
- Download (15.2KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 12 contributors-
Alex Efros
-
Chase Whitener
-
James Raspass
-
Nikolay Mishin
-
Olaf Alders
-
Paul Cochrane
-
Randy Stauner
-
reneeb
-
Shoichi Kaji
-
Stephan Loyd
-
Thorsten Klein
-
Yanick Champoux
NAME
Dist::Zilla::Plugin::GitHubREADME::Badge - Dist::Zilla - add badges to github README.md
SYNOPSIS
# in dist.ini [GitHubREADME::Badge] # configure it yourself [GitHubREADME::Badge] badges = travis badges = travis-ci.com badges = appveyor badges = coveralls badges = gitter badges = cpants badges = issues badges = github_tag badges = license badges = version badges = codecov badges = gitlab_ci badges = gitlab_cover badges = docker_automated badges = docker_build badges = github_actions/test.yml badges = cpancover place = bottom phase = release branch = main
DESCRIPTION
Dist::Zilla::Plugin::GitHubREADME::Badge adds badges to GitHub README.md
CONFIG
badges
Currently only travis, coveralls, codecov, gitter, cpants and GH issues are supported. However patches are welcome.
The default goes to travis, coveralls and cpants.
[GitHubREADME::Badge] badges = travis badges = coveralls badges = gitter badges = cpants
branch
[GitHubREADME::Badge] branch = main
defaults to 'master'. you need set to 'main' for new github repos
place
[GitHubREADME::Badge] place = bottom
Place the badges at the top or bottom of the README. Defaults to top.
phase
[GitHubREADME::Badge] phase = release
Which Dist::Zilla phase to add the badges:
build
,release
orfilemunge
. For thebuild
andrelease
phases, the README that is on disk will be modified, whereas for thefilemunge
it's the internal zilla version of the README that will be modified.The default is
build
.SEE ALSO
Minilla, Dist::Zilla::Plugin::TravisCI::StatusBadge
AUTHOR
Fayland Lam <fayland@gmail.com>
COPYRIGHT
Copyright 2014- Fayland Lam
LICENSE
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Module Install Instructions
To install Dist::Zilla::Plugin::GitHubREADME::Badge, copy and paste the appropriate command in to your terminal.
cpanm Dist::Zilla::Plugin::GitHubREADME::Badge
perl -MCPAN -e shell install Dist::Zilla::Plugin::GitHubREADME::Badge
For more information on module installation, please visit the detailed CPAN module installation guide.