The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

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.2 - 2014-10-13

  • No changes since v1.0.1_08, just a version bump for a release.
  • See the full list of changes since v1.0.0 for more details.
  • Enhancements
    • This is a complete rewrite, using modern Perl with Moo.
    • Added support for plugins, along with plugins to insert the module version, prerequisites and the latest changes.
    • Added the ability to generate a README in a variety of formats, such as POD, Markdown, HTML, RTF, etc.
    • Added command-line options to the pod2readme script, including the ability to specify the output format.
    • Switched to semantic versioning.
    • The documentation has been updated accordingly.
  • Incompatabilities
    • Perl v5.10.1 is required.
    • This is no longer a subclass of a POD parser, although it has some wrapper methods for compatability with software known to use it.

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