Magento-Extension-Sample-Readme

This is an attempt to develop a default readme file for Magento extensions. It should be included in the Magento extension directory under e.g. app/code/community/Company/ExampleExtension/readme.markdown. The markdown syntax (http://daringfireball.net/projects/markdown/syntax) is used for better and consistent formatting. Please join the discussion - open issues and send pull requests! Thanks to Josh Pratt for the idea: http://prattski.com/2012/08/30/magento-dev-best-practices-module-readme-files/. Maintained by sprankhub on GitHub, where it has earned 15 stars from the community.

It's actively developed around magento, readme, readme-template, and is a solid reference for anyone building with these tools.