NAME

Dist::Zilla::Plugin::ReadmeFromPod - Automatically convert POD to a README for Dist::Zilla

VERSION

version 0.06

SYNOPSIS

# dist.ini
[ReadmeFromPod]

# or
[ReadmeFromPod]
filename = lib/XXX.pod

# to fix "[DZ] attempt to add README multiple times; added by: @Filter/Readme
[@Filter]
remove = Readme

[ReadmeFromPod]

DESCRIPTION

generate the README from main_module (or specified) by Pod::Text

The code is mostly a copy-paste of Module::Install::ReadmeFromPod

AUTHOR

Fayland Lam <fayland@gmail.com>

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

To install Dist::Zilla::Plugin::ReadmeFromPod, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Dist::Zilla::Plugin::ReadmeFromPod

CPAN shell

perl -MCPAN -e shell
install Dist::Zilla::Plugin::ReadmeFromPod

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)