NAME
Dist::Zilla::Plugin::JSAN::ReadmeFromMD - build a README file
VERSION
version 0.01_02
SYNOPSIS
In your dist.ini:
[JSAN::ReadmeFromMD]
update_sources = 1; this is a defaultDESCRIPTION
This plugin adds a README.md file to the distribution, which just copy the markdown (or multi-markdown) documentation file of the main module.
By default it also modifies your sources and add the same file to the root of them. Its useful for GitHub, in which the README's content shows at the projects home page. You can disable this behavior with the update_sources option, by setting it to 0.
Of course, this plugins assumes, that your documentation is written in markdown and is already generated. Therefor it should be included *after* the [JSAN] plugin.
If this plugin can't find the documentation file it falls back to standard [README] plugin behavior
AUTHOR
Nickolay Platonov <nplatonov@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2010 by Nickolay Platonov.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.