arpitjjw / 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/

Company Example Extension

This is a short description of what the extension does.

Facts

• version: 0.1.0
• extension key: Company_ExampleExtension
• extension on Magento Connect
• Magento Connect 1.0 extension key: magento-community/Company_ExampleExtension
• Magento Connect 2.0 extension key: http://connect20.magentocommerce.com/community/Company_ExampleExtension
• extension on GitHub
• direct download link

Description

This paragraph describes what the extension does.

Requirements

• PHP >= 5.6.0
• Mage_Core
• ...

Compatibility

• Magento >= 1.9

Installation Instructions

1. Install the extension via Magento Connect with the key shown above or copy all the files into your document root.
2. Clear the cache, logout from the admin panel and then login again.
3. Configure and activate the extension under System - Configuration - Company - Example Extension.
4. ...

Uninstallation

1. Remove all extension files from your Magento installation
2. ...

Support

If you have any issues with this extension, open an issue on GitHub.

Contribution

Any contribution is highly appreciated. The best way to contribute code is to open a pull request on GitHub.

Developer

FirstName LastName
http://www.firstname-lastname.com
@FirstNameLastName

License

OSL - Open Software Licence 3.0

Copyright

(c) 2017 Company