I've started adding the following badge section to my top level module pod so information is provided but maintenance is not required. This includes the minimum perl supported, current github version, CPAN version, Travis-CI state, Coveralls information, and Kwalitee score for that package.
Probably overkill but once it's set up you don't have to mess with it anymore. The down side is it will only display in browsers not in man pages. Inspect the various specific urls for your implementation substitutions. I generally put it right after the NAME section.
=begin html
<a href="https://www.perl.org">
<img src="https://img.shields.io/badge/perl-5.10+-brightgreen.svg"
+ alt="perl version">
</a>
<a href="https://travis-ci.org/jandrew/p5-spreadsheet-reader-excelxml"
+>
<img alt="Build Status" src="https://travis-ci.org/jandrew/p5-spre
+adsheet-reader-excelxml.png?branch=master" alt='Travis Build'/>
</a>
<a href='https://coveralls.io/github/jandrew/p5-spreadsheet-reader-exc
+elxml?branch=master'>
<img src='https://coveralls.io/repos/github/jandrew/p5-spreadsheet
+-reader-excelxml/badge.svg?branch=master' alt='Coverage Status' />
</a>
<a href='https://github.com/jandrew/p5-spreadsheet-reader-excelxml'>
<img src="https://img.shields.io/github/tag/jandrew/p5-spreadsheet
+-reader-excelxml.svg?label=github version" alt="github version"/>
</a>
<a href="https://metacpan.org/pod/Spreadsheet::Reader::ExcelXML">
<img src="https://badge.fury.io/pl/Spreadsheet-Reader-ExcelXML.svg
+?label=cpan version" alt="CPAN version" height="20">
</a>
<a href='http://cpants.cpanauthors.org/dist/Spreadsheet-Reader-ExcelXM
+L'>
<img src='http://cpants.cpanauthors.org/dist/Spreadsheet-Reader-Ex
+celXML.png' alt='kwalitee' height="20"/>
</a>
=end html
For the github badge to work you have to draft a release with the package version as the 'Tag version'
-
Are you posting in the right place? Check out Where do I post X? to know for sure.
-
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big>
<blockquote> <br /> <dd>
<dl> <dt> <em> <font>
<h1> <h2> <h3> <h4>
<h5> <h6> <hr /> <i>
<li> <nbsp> <ol> <p>
<small> <strike> <strong>
<sub> <sup> <table>
<td> <th> <tr> <tt>
<u> <ul>
-
Snippets of code should be wrapped in
<code> tags not
<pre> tags. In fact, <pre>
tags should generally be avoided. If they must
be used, extreme care should be
taken to ensure that their contents do not
have long lines (<70 chars), in order to prevent
horizontal scrolling (and possible janitor
intervention).
-
Want more info? How to link
or How to display code and escape characters
are good places to start.
|