search

Csson / p5-Pod-Weaver-Section-Badges

Insert badges in your pod
Other
1 stars 1 forks source link

documentation missing for some options #1

Open karenetheridge opened 9 years ago

karenetheridge commented 9 years ago

There is no documentation for some options used in the synopsis (-travis_user, -travis_repo, -travis_branch, -gratipay_user) -- are they required, or are they calculated from something if omitted? It would be handy if some of the information (e.g. github repository) could be determined from other plugins in use.

Csson commented 9 years ago

Hi!

I have added a bit of documentation (in 0.0203) regarding the dash-prefixed attributes (the short of it is that they are attributes of the badges used rather than Pod::Weaver::Section::Badges). Is it better now?

I have wanted to reduce duplicity of documentation so all badge specific documentation is only available in each badge's documentation, but I did get around to add some support for reading metadata (if available) for the Travis badge: Since the badges are also usable outside of a dzil/podweaver environment it looks directly in META.json for repository information, and I also set 'master' as the default branch. The Perl badge does the same. I guess it might depend on which dzil plugins are used if META.json is available, so that remains to handle.

I plan to add more documentation for each badge regarding how to use it with Pod::Weaver::Section::Badges.

Thanks for your input, it's much appreciated :+1: