NAME¶

Pod::Readme::Filter - Filter README from POD

SYNOPSIS¶

  use Pod::Readme::Filter;
  my $prf = Pod::Readme::Filter->new(
    target      => 'readme',
    base_dir    => '.',
    input_file  => 'lib/MyApp.pm',
    output_file => 'README.pod',
  );

DESCRIPTION¶

This module provides the basic filtering and minimal processing to extract a README.pod from a module's POD. It is used internally by Pod::Readme.