NAME

Dist::Zilla::Plugin::TravisCI::StatusBadge - Get Travis CI status badge for your markdown README

VERSION

version 0.009

SYNOPSIS

    ; in dist.ini
    [TravisCI::StatusBadge]
    user = johndoe
    repo = p5-John-Doe-Stuff
    branch = foo        ;; "master" by default
    vector = 1          ;; SVG image

    ; or just
    [TravisCI::StatusBadge]
    ;; shortcut for "png image; master branch; user/repo from meta resources"

DESCRIPTION

Injects the Travis CI Build status badge before the VERSION header into any form of README.[md|pod] file.

Traget readme might be pointed via option "readme" or guessed by module.

Use Dist::Zilla::Plugin::ReadmeAnyFromPod in markdown mode or any other plugin to generate target file

    [ReadmeAnyFromPod / ReadmeMdInRoot]
    type     = markdown
    filename = README.md
    location = root

OPTIONS

readme

The name of file to inject build status badge. No default value but there is some logic to guess target filename. File can be named as README or Readme and has the one of following extensions: md, mkdn, markdown or pod.

In case of some name passed via this option, it will be used only if the target file exists otherwise will be checked default variations and used first found.

format

Either pod or markdown. Optional. When unspecified, format is pod if readme has a .pod file extension and markdown otherwise.

user

Github username. Might be obtained automatically (if not given) from META resources (resources.homepage, resources.repository.web, resources.repository.url).

repo

Github repository name. Might be obtained automatically (if not given) from META resources (resources.homepage, resources.repository.web, resources.repository.url).

branch

Branch name which build status should be shown. Optional. Default value is master.

vector

Use vector representation (SVG) of build status image. Optional. Default value is false which means using of the raster representation (PNG).

SEE ALSO

Please see those modules/websites for more information related to this module.

• https://travis-ci.org

• Dist::Zilla::Plugin::ReadmeAnyFromPod

• Dist::Zilla::Plugin::GithubMeta

• Dist::Zilla::Role::AfterBuild

• Dist::Zilla

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/Wu-Wu/Dist-Zilla-Plugin-TravisCI-StatusBadge/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

Anton Gerasimov <chim@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Anton Gerasimov.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm Dist::Zilla::Plugin::TravisCI::StatusBadge

perl -MCPAN -e shell
install Dist::Zilla::Plugin::TravisCI::StatusBadge