README vs README.md

Happened to notice that https://github.com/Dual-Life/Devel-PPPort displays a markdown version of its POD when you navigate to it on GitHub. Digging a bit deeper I see that does that by strong a README.md file in the .github directory - somehow GitHub spots it and uses it for the module landing page. Quite a neat approach because the .github directory doesn't end up in the CPAN bundle. Also means that the plain-vanilla text README isn't touched.

Before I jump in with both feet and replicate this, do we have any guidance on the general approach? Also is there any tooling to automate the process? (Not that it's a big deal to create it).

Paul

• README vs README.md by Paul Marquess
• Re: README vs README.md by Karen Etheridge
• Re: README vs README.md by Graham Knop
• Re: README vs README.md by Karen Etheridge
• Re: README vs README.md by book
• Re: README vs README.md by Lukas Mai
• RE: README vs README.md by paul.marquess via perl5-porters
• Re: README vs README.md by Ryan Thompson
• RE: README vs README.md by paul.marquess via perl5-porters