1.0.3 • Published 9 years ago

cpan-distributions-list v1.0.3

Weekly downloads
2
License
MIT
Repository
github
Last release
9 years ago

CPAN Distributions List

Build Status Coverage Status License

Display a list of CPAN distributions and related information for a specified Perl author.

Getting Started

Download the production version or the development version.

Add the following in your HEAD section:

<script src="libs/jquery/jquery.js"></script>
<script src="dist/cpan-distributions-list.min.js"></script>
<script>
	$('#cpan_distributions').createDistributionsList(
		{
			pause_id: "AUBERTG",
			github_id: "guillaumeaubert",
		}
	);
</script>

Add the following to your BODY section:

<table id="cpan_distributions">
	<thead>
		<th>Distribution</th>
		<th>Current Version</th>
		<th>Links</th>
		<th>Build Status</th>
		<th>Test Coverage</th>
	</thead>
	<tbody>
		<tr style="display: none;" class="template">
			<td class="distribution"><!-- Name of the distribution --></td>
			<td class="version"><!-- Current version of the distribution --></td>
			<td class="links">
				<span class="github"><!-- GitHub link --></span>
				|
				<span class="metacpan"><!-- MetaCPAN link --></span>
				|
				<span class="cpants"><!-- CPANTS link --></span>
			</td>
			<td class="travis_status_badge"><!-- Travis CI - badge to indicate build status --></td>
			<td class="coveralls_badge"><!-- Coveralls.io - badge to indicate test coverage percentage --></td>
		</tr>
	</tbody>
</table>

Documentation

createDistributionsList() accepts the following arguments:

Development

  1. Install Node.JS.

  2. Install Grunt.

  3. Clone the repository: git clone git@github.com:guillaumeaubert/jquery-cpan-distributions-list.git

  4. Install the project dependencies: cd jquery-cpan-distributions-list && npm install

  5. Run Grunt to check the files and rebuild: grunt

Copyright

Copyright (C) 2013-2016 Guillaume Aubert

License

This software is released under the MIT license. See the LICENSE file for details.