[libdist-zilla-role-bootstrap-perl] 09/09: Furnish a simple DESCRIPTION section for README

[Axel Beckert]

This is an automated email from the git hooks/post-receive script.

abe pushed a commit to annotated tag 1.001000-source
in repository libdist-zilla-role-bootstrap-perl.

commit f0042b5f70089423c99039b8991d5c41271fefee
Author: Kent Fredric <kentfredric at gmail.com>
Date:   Wed Jan 21 09:29:54 2015 +1300

    Furnish a simple DESCRIPTION section for README
---
 Changes                          |  3 +++
 README.mkdn                      | 28 ++++++++++++++++++++++++++++
 lib/Dist/Zilla/Role/Bootstrap.pm | 33 +++++++++++++++++++++++++++++++++
 3 files changed, 64 insertions(+)

diff --git a/Changes b/Changes
index 1ab0398..6d238d8 100644
--- a/Changes
+++ b/Changes
@@ -8,6 +8,9 @@ Release history for Dist-Zilla-Role-Bootstrap
  - runtime: -1 (recommends: +1)
  - test: +1 (recommends: +1 ↑1 ↓1)
 
+ [Documentation]
+ - Furnish a simple DESCRIPTION section for README
+
  [Internals]
  - Cease use of MX::AttributeShortcuts to remove autobox indirect dependency.
 
diff --git a/README.mkdn b/README.mkdn
index 14f95fe..6966f02 100644
--- a/README.mkdn
+++ b/README.mkdn
@@ -28,6 +28,34 @@ For users of plugins:
     fallback  = 0 ; # don't bootstrap at all if /Dist-Name-.*/ matches != 1 things
     fallback  = 1 ; # fallback to / if /Dist-Name-.*/ matches != 1 things
 
+# DESCRIPTION
+
+This module is a role that aims to be consumed by plugins that want to perform
+some very early bootstrap operation that may affect the loading environment of
+successive plugins, especially with regards to plugins that may wish to build with
+themselves, either by consuming the source tree itself, or by consuming a previous
+built iteration.
+
+Implementation is quite simple:
+
+- 1. `with` this role in your plugin
+
+        with 'Dist::Zilla::Role::Bootstrap'
+
+- 2. Implement the `bootstrap` sub.
+
+        sub bootstrap {
+          my ( $self ) = @_;
+        }
+
+- 3. _Optional_: Fetch the discovered `bootstap` root via:
+
+        $self->_bootstap_root
+
+- 4. _Optional_: Load some path into `@INC` via:
+
+        $self->_add_inc($path)
+
 # REQUIRED METHODS
 
 ## `bootstrap`
diff --git a/lib/Dist/Zilla/Role/Bootstrap.pm b/lib/Dist/Zilla/Role/Bootstrap.pm
index 152ef34..bf94242 100644
--- a/lib/Dist/Zilla/Role/Bootstrap.pm
+++ b/lib/Dist/Zilla/Role/Bootstrap.pm
@@ -313,4 +313,37 @@ For users of plugins:
     fallback  = 0 ; # don't bootstrap at all if /Dist-Name-.*/ matches != 1 things
     fallback  = 1 ; # fallback to / if /Dist-Name-.*/ matches != 1 things
 
+=head1 DESCRIPTION
+
+This module is a role that aims to be consumed by plugins that want to perform
+some very early bootstrap operation that may affect the loading environment of
+successive plugins, especially with regards to plugins that may wish to build with
+themselves, either by consuming the source tree itself, or by consuming a previous
+built iteration.
+
+Implementation is quite simple:
+
+=over 4
+
+=item 1. C<with> this role in your plugin
+
+  with 'Dist::Zilla::Role::Bootstrap'
+
+=item 2. Implement the C<bootstrap> sub.
+
+  sub bootstrap {
+    my ( $self ) = @_;
+  }
+
+=item 3. I<Optional>: Fetch the discovered C<bootstap> root via:
+
+  $self->_bootstap_root
+
+=item 4. I<Optional>: Load some path into C<@INC> via:
+
+  $self->_add_inc($path)
+
+=back
+
+
 =cut

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libdist-zilla-role-bootstrap-perl.git