Pending changes

BACKGROUND.md

@@ -0,0 +1,18 @@
+# Introduction
+When customizing Magento emails, you have the choice of modifying the template through the **Magento Admin Panel**,
+or through the system folder `app/locale/xx_XX/template/email`. The last option classifies as a core hack, and with every upgrade your changes will be gone. The first option requires you to modify code within a textarea and no syntax highlightning available.
+
+# Override email templates
+This extension allows you to create file-based overrides of the Magento email templates within your own custom Magento theme. You can simply copy templates around, and modify the files using favorite IDE.
+
+    app/design/frontend/{PACKAGE}/{THEME}/locale/{LOCALE}/template/email
+
+In the path, `{PACKAGE}` placeholder reflects your own theming package, `{THEME}` reflects the Magento theme you are
+using and `{LOCALE}` reflects the language locale you are using - for example `en_US` or `de_DE`. Refer to the Magento documentation on how to configure theming and locales.
+
+# Override CSV files
+An additional feature of this module is that CSV translation files like `Mage_Checkout.csv` can also be overrridden in your theme. For instance:
+
+    app/design/frontend/default/mytheme/locale/en_US/Mage_Checkout.csv
+
+This allows you to make any changes to any language file simply by copying files.

INSTALL.md

@@ -0,0 +1,58 @@
+# Installation
+You can install this module in various ways:
+
+1) Download the MagentoConnect package from our site and upload it into your own Magento
+Downloader application.
+
+2) Download the Magento source archive from our site, extract the files and upload the
+files to your Magento root. Make sure to flush the Magento cache. Make sure to logout 
+once you're done.
+
+3) Use modman to install the git repository for you:
+
+    modman init
+    modman clone https://github.com/yireo/Yireo_EmailOverride
+    modman update Yireo_EmailOverride
+
+4) Use composer. See below
+
+## Instructions for using composer
+
+Use composer to install this extension. First make sure to initialize composer with the right settings:
+
+    composer -n init
+    composer install --no-dev
+
+Next, modify your local composer.json file:
+
+    {
+        "require": {
+            "yireo/magento1-emailoverride": "dev-master",
+            "magento-hackathon/magento-composer-installer": "*"
+        },    
+        "repositories":[
+            {
+                "packagist": false
+            },
+            {
+                "type":"composer",
+                "url":"https://packages.firegento.com"
+            },
+            {
+                "type":"composer",
+                "url":"https://satis.yireo.com"
+            }
+        ],
+        "extra":{
+            "magento-root-dir":"/path/to/magento",
+            "magento-deploystrategy":"copy"           
+        }
+    }
+
+Make sure to set the `magento-root-dir` properly. Test this by running:
+
+    composer update --no-dev
+
+Done.
+
+Bring your towel.

README.md

@@ -1,62 +1,2 @@
 # Yireo EmailOverride
 Magento extension for overriding email templates in your own Magento theme.
-
-More information: https://www.yireo.com/software/magento-extensions/email-override
-
-You can install this module in various ways:
-
-1) Download the MagentoConnect package from our site and upload it into your own Magento
-Downloader application.
-
-2) Download the Magento source archive from our site, extract the files and upload the
-files to your Magento root. Make sure to flush the Magento cache. Make sure to logout 
-once you're done.
-
-3) Use modman to install the git repository for you:
-
-    modman init
-    modman clone https://github.com/yireo/Yireo_EmailOverride
-    modman update Yireo_EmailOverride
-
-4) Use composer. See below
-
-## Instructions for using composer
-
-Use composer to install this extension. First make sure to initialize composer with the right settings:
-
-    composer -n init
-    composer install --no-dev
-
-Next, modify your local composer.json file:
-
-    {
-        "require": {
-            "yireo/magento1-emailoverride": "dev-master",
-            "magento-hackathon/magento-composer-installer": "*"
-        },    
-        "repositories":[
-            {
-                "packagist": false
-            },
-            {
-                "type":"composer",
-                "url":"https://packages.firegento.com"
-            },
-            {
-                "type":"composer",
-                "url":"https://satis.yireo.com"
-            }
-        ],
-        "extra":{
-            "magento-root-dir":"/path/to/magento",
-            "magento-deploystrategy":"copy"           
-        }
-    }
-
-Make sure to set the `magento-root-dir` properly. Test this by running:
-
-    composer update --no-dev
-
-Done.
-
-Bring your towel.

composer.json

@@ -2,7 +2,7 @@
     "name": "yireo/magento1-emailoverride",
     "license": "OSL-3.0",
     "type": "magento-module",
-    "homepage": "https://www.yireo.com/software/magento-extensions/email-override",
+    "homepage": "https://github.com/yireo/Yireo_EmailOverride",
     "description": "Override Magento emails in your app/design/frontend/PACKAGE/THEME/locale folder",
     "authors": [
         {
@@ -11,7 +11,7 @@
         }
     ],
     "require": {
-        "php": ">=5.3.0"
+        "php": ">=7.0.0"
     },
     "require-dev":{
         "phpunit/phpunit":"*",