Skip to content
Browse files

clean up and document the pm file

  • Loading branch information...
1 parent 8902d4b commit 2e27f6f34e72ddd7e820f287efa4cfc560837c64 @xdg xdg committed
Showing with 16 additions and 8 deletions.
  1. +16 −8 lib/Dist/Zilla/Plugin/CheckMetaResources.pm
View
24 lib/Dist/Zilla/Plugin/CheckMetaResources.pm
@@ -7,8 +7,6 @@ package Dist::Zilla::Plugin::CheckMetaResources;
# VERSION
# Dependencies
-use autodie 2.00;
-
use Dist::Zilla 4 ();
use autodie 2.00;
use Moose 0.99;
@@ -65,17 +63,27 @@ __PACKAGE__->meta->make_immutable;
=head1 DESCRIPTION
-This is a "before release" Dist::Zilla plugin that ensures that your META file
-will contain some "resources" data. If it doesn't find any, it will abort the
-release process.
+This is a "before release" L<Dist::Zilla> plugin that ensures that your META file
+will contain some "resources" data.
-=head1 USAGE
+By default, it requires you to have at least 'repository' and 'bugtracker'
+sections, but 'homepage' is optional.
-Good luck!
+You can toggle any of these checks on or off. For example:
+
+ [CheckMetaResources]
+ repository = 1
+ bugtracker = 0
+ homepage = 1
=head1 SEE ALSO
-Maybe other modules do related things.
+=for :list
+* L<Dist::Zilla>
+* L<Dist::Zilla::Plugin::MetaResources>
+* L<Dist::Zilla::Plugin::GithubMetas>
+* L<Dist::Zilla::Plugin::AutoMetaResources>
+* ... and plenty more (search metacpan.org for "dist zilla plugin meta")
=cut

0 comments on commit 2e27f6f

Please sign in to comment.
Something went wrong with that request. Please try again.