From b285ddc8bf22e85fbba770aa99dab6ac2fca5255 Mon Sep 17 00:00:00 2001 From: "Ryan C. Thompson" Date: Wed, 6 Aug 2014 09:06:52 -0700 Subject: [PATCH] Expand documentation for phase options --- lib/Dist/Zilla/Plugin/ReadmeAnyFromPod.pm | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/lib/Dist/Zilla/Plugin/ReadmeAnyFromPod.pm b/lib/Dist/Zilla/Plugin/ReadmeAnyFromPod.pm index 2c49976..f547906 100644 --- a/lib/Dist/Zilla/Plugin/ReadmeAnyFromPod.pm +++ b/lib/Dist/Zilla/Plugin/ReadmeAnyFromPod.pm @@ -154,13 +154,16 @@ At what phase to generate the README file. Choices are: =item build -(Default) This generates the README at 'after build' time. +(Default) This generates the README at 'after build' time. A new +README will be generated each time you build the dist. =item release -This generates the README at 'after release' time. Note that this is too late -to get the file into the generated tarball (C), but ideal if -you are using C. +This generates the README at 'after release' time. Note that this is +too late to get the file into the generated tarball, and is therefore +incompatible with C. However, this is ideal if you +are using C and only want to update the README upon +each release of your module. =back