Magento-Extension-Sample-Readme
Magento-Extension-Sample-Readme copied to clipboard
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.markd...
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
- Install the extension via Magento Connect with the key shown above or copy all the files into your document root.
- Clear the cache, logout from the admin panel and then login again.
- Configure and activate the extension under System - Configuration - Company - Example Extension.
- ...
Uninstallation
- Remove all extension files from your Magento installation
- ...
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