Permalink
Browse files

documentation

  • Loading branch information...
1 parent 0a3c5a4 commit d049f341b07760a4e11dc835c8433a8197b10ac7 @semuel committed Jul 2, 2013
Showing with 22 additions and 3 deletions.
  1. +2 −1 dist.ini
  2. +20 −2 lib/Dist/Surveyor.pm
View
@@ -43,7 +43,8 @@ Module::CoreList = 0
Module::Metadata = 0
JSON = 0
-[Prereqs / Test]
+[Prereqs]
+-phase = test
Archive::Tar = 0
[MinimumPerl]
View
@@ -6,7 +6,22 @@ Dist::Surveyor - Survey installed modules and determine the specific distributio
=head1 SYNOPSIS
-See L<dist_surveyor> for documentation.
+ my $options = {
+ opt_match => $opt_match,
+ opt_perlver => $opt_perlver,
+ opt_remnants => $opt_remnants,
+ distro_key_mod_names => $distro_key_mod_names,
+ };
+ my @installed_releases = determine_installed_releases($options, \@libdirs);
+
+=head1 DESCRIPTION
+
+Surveys your huge ball of Perl modules, jammed together inside a directory,
+and tells you exactly which module is installed there.
+
+For quick start, and a fine example of this module usage, see L<dist_surveyor>.
+
+This module have one exported function - determine_installed_releases
=cut
@@ -530,9 +545,12 @@ This module checks $::DEBUG and $::VERBOSE for obvious proposes.
This module uses L<Dist::Surveyor::Inquiry> to communicate with MetaCPAN.
Check that module's documentation for options and caching.
+You can use L<Dist::Surveyor::MakeCpan> to take the list of releases
+and create a mini-cpan containing them.
+
=head1 AUTHOR
-Written by Tim Bunce E<lt>Tim.Bunce@pobox.com<gt>
+Written by Tim Bunce E<lt>Tim.Bunce@pobox.comE<gt>
Maintained by Fomberg Shmuel, E<lt>shmuelfomberg@gmail.comE<gt>

0 comments on commit d049f34

Please sign in to comment.