Changes for version v1.0.1_05 - 2014-10-09

  • Documentation
    • Corrected typos in POD.
  • Bug Fixes
    • Disabled use of Test::Kit, since it seems to have problems with Test::Builder 1.301001_056.

Changes for version v1.0.1_04 - 2014-10-08

  • Documentation
    • Changed abstract to make the module's purpose more obvious.
  • Bug Fixes
    • Added missing IO::String prereq to tests.

Changes for version v1.0.1_03 - 2014-10-08

  • Documentation
    • Added Acknowledgements section to POD.
  • Bug Fixes
    • Added minimum version prereq of Moo to fix issue with undef defaults.
  • Enhancements
    • Changed to use Path::Tiny instead of Path::Class.
    • Reverted back to using Exporter, since most core modules already use it.

Changes for version v1.0.1_02 - 2014-10-08

  • Documentation
    • Added missing timestamp to Changes.
    • Updated README.pod.
  • Other Changes
    • Changed how versions are defined in modules, to handle quirks of namespace::autoclean.
    • Changed to use Exporter::Lite.

Changes for version v1.0.1_01 - 2014-10-08

  • Bug Fixes
    • Fixed argument name for include command.
    • Changed tests to compare files so they handle different Windows line endings.
  • Documentation
    • Fixed POD errors and typos.
  • Enhancements
    • Switched to use Type::Tiny-based types, with stricter constraints.
    • Switched to use Moo instead of Moose.
  • Other Changes
    • Minor internal code tweaks.

Changes for version v1.0.0_03 - 2014-09-24

  • Bug Fixes
    • The tests for the requires plugin handle non-author builds.
    • Fix for tests on some systems.
  • Enhancements
    • Show path of missing META.yml file in requires plugin.
  • Documentation
    • Consistent names in POD.
    • Fixed typos in Changes file.
  • Other Changes
    • Added hooks for author tests in Makefile.PL.
    • Fixed license metadata error to make CPANTS happy, and to be consistent with license in the POD.
    • Tests use Exporter instead of Exporter::Lite.
    • Tests use Test::Kit rather than Test::Most, and explicitly import the tests modules that they use.
    • Removed redundant prereqs from Makefile.PL.

Changes for version v1.0.0_02 - 2014-09-24

  • Bug Fixes
    • Fixed minimum version of some prerequisites for tests.
  • Enhancements
    • Added parse_from_file and parse_from_filehandle methods for backwards compatability.
  • Other Changes
    • Added more tests.
    • The bugtracker URL now refers to the GitHub issues list at https://github.com/bigpresh/Pod-Readme/issues instead of RT.
    • Added a version to all modules in the distribution, and a version QA test to the repo.
  • Documentation
    • Added missing date to Changes.
    • Fixed typos in POD and README.
    • Added stub POD to Pod::Readme::Filter.
    • Fixed a daft typo in the Changes file.
    • Documented known issue in the requires plugin.
    • The README is now a POD document.

Changes for version v1.0.0_01 - 2014-09-23

  • Incompatabilities
    • Major rewrite, using modern Perl v5.10.1.
    • This module is no longer a subclass of a POD parsing module. Instead, it is a simple POD filter.
  • New Features
    • Added support for plugins.
    • Added a "changes" plugin for parsing Changes files.
    • Added a "version" plugin for including the current version.
    • Added a "requires" plugin for listing module requirements.
    • The pod2readme script has been rewritten to take a variety of options, and can generate various formats, such as HTML, Markdown, POD or RTF.
  • Documentation
    • Changes rewritten to conform to CPAN::Changes::Spec.
    • README is now in Markdown format.
  • Other Changes
    • Switched to semantic versioning.
    • Added MANIFEST.SKIP to distribution.
    • QA tests are no longer part of the distribution.
    • Makefile.PL uses Module::Install.

Documentation

Intelligently generate a README file from POD

Modules

Intelligently generate a README file from POD
Filter README from POD
plugin role for Pod::Readme
include latest Changes in README
include requirements in README
include version in README
types used by Pod::Readme