adding documentation

1 files changed, 21 insertions, 0 deletions

diff --git a/perl.req-from-meta b/perl.req-from-meta
index fdc149d..5b612dd 100755
--- a/perl.req-from-meta
+++ b/perl.req-from-meta
@@ -31,3 +31,24 @@ foreach my $module ( sort keys %$requires ) {
 }
 
 exit;
+
+=head1 NAME
+
+perl.req-from-meta - extract requires from meta file
+
+=head1 SYNOPSIS
+
+    $ perl.req-from-meta /path/to/META.yml
+    $ perl.req-from-meta /path/to/META.json
+
+=head1 DESCRIPTION
+
+This script will extract Perl requirements from the distribution meta
+file. For each such requires, it'll convert the minimum version to
+follow mandriva perl versioning (using C<%perl_convert_version>), and
+print them as:
+
+    perl(Foo::Bar)
+    perl(App::Frobnizer) >= 1.23.456
+
+Minimum perl version are skipped.