Kraken Ink Template Readme

README.md

Kraken ExtensionName Extension

Description

Give a brief description of the extension here.

Usage Instructions

• List any usage and deployment instructions
• Consider including any preference overrides that may conflict with other extension

Known Issues

• Include any known issues, such as incompatibilities with other extension

Installation Instructions

Option 1 - Install extension using Composer (default approach)

composer config repositories.kraken/extension-name git [email protected]:krakencommerce/kraken_extensionname.git
composer require kraken/extension-name:dev-master
bin/magento module:enable --clear-static-content Kraken_ExtensionName
bin/magento setup:upgrade
bin/magento cache:flush

Option 2 - Install extension by copying files into project (only if the project requires it for some reason)

mkdir -p app/code/Kraken/ExtensionName
git archive --format=tar [email protected]:krakencommerce/kraken_extensionname.git master | tar xf - -C app/code/Kraken/ExtensionName/
bin/magento module:enable --clear-static-content Kraken_ExtensionName
bin/magento setup:upgrade
bin/magento cache:flush

Uninstallation Instructions

These instructions work regardless of how you installed the extension:

bin/magento module:disable --clear-static-content Kraken_ExtensionName
rm -rf app/code/Kraken/ExtensionName
composer remove kraken/extension-name
mr2 db:query 'DELETE FROM `setup_module` WHERE `module` = "Kraken_ExtensionName"'
bin/magento cache:flush