From ab36f088025862efd685bfdb345f147d5f8d4a4f Mon Sep 17 00:00:00 2001 From: Kevin Bibby Date: Mon, 17 Feb 2014 21:51:06 +0000 Subject: [PATCH] readme changes for v1.0 --- readme.txt | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/readme.txt b/readme.txt index 49140ae..5d061cf 100644 --- a/readme.txt +++ b/readme.txt @@ -4,7 +4,7 @@ InaneCoding Piwik OpenCart Ecommerce VQmod Source Repository: https://github.com/InaneCoding/Piwik-OpenCart-Ecommerce-VQMod Author: Kevin Bibby / InaneCoding.co.uk Version: 1.0 -Release Date: 2013-09-16 +Release Date: 2014-02-17 License: GNU General Public License (GPL) version 3 ------------------------------------------------------ @@ -40,8 +40,8 @@ If you have used a custom Admin path then please place all files from '/upload/a -INSTALLATION ------------- +INSTALL +------- 1) Upload the contents of the 'Upload' directory to the root of your OpenCart site. 2) Login to your OpenCart admin, go to the Extensions -> Modules page, and click 'Install' next to 'Piwik OpenCart Ecommerce mod'. 3) After install, click 'Edit' next to 'Piwik', and on the settings page enter the details about your site and the Piwik installation; @@ -54,17 +54,26 @@ e) "Piwik Site ID" - This is the ID used in your Piwik install for the site you f) "Piwik Tracking" - Global 'Enabled' / 'Disabled' setting for the Piwik OpenCart mod. g) "Ecommerce tracking" - Set this to 'Enabled' to allow tracking of Ecommerce actions such as product views, cart operations and orders. Set this to 'Disabled' if you only wish to track regular page views. h) "Piwik Proxy Script" - Set this to 'Enabled' to route all Piwik tracking requests through the Piwik Proxy script at the root of your site; useful if the "Piwik Installation URL" is at another URL/server which you don't want to make public. -i) "Piwik SKU" - Select what product field you would like to use when reporting the SKU (Stock Keeping Unit) in an Ecommerce operation. This can use either OpenCarts 'Model' product field, or the 'SKU' product field. +i) "Piwik SKU" - Select what product field you would like to use when reporting the SKU (Stock Keeping Unit) in an Ecommerce operation. This can use either the 'Model' or 'SKU' fields which every product in OpenCart has. UPGRADE ------- To upgrade from a previous version simply upload the files from the new version as described in step 1) of the installation. -There should be no need to re-install anything or change any settings as I've tried to pay attention to backwards compatbility during development. +There should be no need to re-install anything or change any settings as I've tried to pay attention to backwards compatibility during development. Please get in touch if you experience any issues. + +UNINSTALL +--------- +In OpenCart admin, go to the Extensions -> Modules page, and simply click 'Uninstall' next to 'Piwik OpenCart Ecommerce mod'. +This will ensure the configuration settings are deleted and that none of the main functions of the mod will run. +Some files will still remain - however these should be perfectly safe and not affect anything but to fully remove please delete all files which you uploaded during the install. + + + LIMITATIONS ----------- This is the first widespread release but would still benefit from further feedback. Please report any bugs found! @@ -75,7 +84,7 @@ This is the first widespread release but would still benefit from further feedba VERSION HISTORY --------------- -v1.0 - 2013/11/ +v1.0 - 2014/02/17 First version to be listed on opencart.com extension store (jump to v1.0). Order tracking now called from success page (fixes issue with order attributed to payment processor). Global enable/disable setting on admin page now implemented.