From 3d99105a4d0326e935ed6f8f3406b902d19aaedf Mon Sep 17 00:00:00 2001 From: zsoltoroszlany82 Date: Mon, 11 Nov 2024 09:10:38 +0100 Subject: [PATCH] readme update --- README.md | 62 +++++++++++++------------------- compress.js | 1 + src/installation.txt | 86 ++++++++++++++++++++------------------------ 3 files changed, 65 insertions(+), 84 deletions(-) diff --git a/README.md b/README.md index 5c2851c..4c1169f 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,54 @@ # Playful Sparkle - COD fee for OpenCart 3 -The **Playful Sparkle - COD fee** automatically adds a configurable fee to the total order cost during checkout when the customer selects **Cash on Delivery (COD)** as the payment method. +The **Playful Sparkle - COD fee** extension for OpenCart 3.x+ allows store owners to easily add a customizable fee when customers choose **Cash on Delivery (COD)** as their payment method. Designed to streamline the payment process, it ensures accurate handling of cash on delivery fees directly within checkout. This extension helps cover transaction costs for businesses, enhancing the overall checkout experience by transparently including the fee where applicable. Perfect for e-commerce businesses of all sizes, it requires no technical expertise to set up and integrates seamlessly with OpenCart 3.x+. --- ## Features -### Playful Sparkle - COD fee -- Adds a customizable fee to the total when **Cash on Delivery (COD)** is selected during checkout. -- Configurable fee options: fixed amount to be added to the total order value. -- Easy setup via the OpenCart 3.x interface. -- Compatible with OpenCart 3.x. -- **Multilingual Support**: The extension is available in the following languages: - - Čeština (cs-cz) - - Deutsch (de-de) - - English (GB) (en-gb) - - English (US) (en-us) - - Español (es-es) - - Français (fr-fr) - - Magyar (hu-hu) - - Italiano (it-it) - - Русский (ru-ru) - - Slovenčina (sk-sk) +- **Configurable fee options**: A fixed amount can be added to the total order value. +- **Compatibility**: Integrates smoothly with OpenCart 3.x+, supporting a range of online store setups. +- **Multilingual Support**: Ready for international use with languages including Čeština (cs-cz), Deutsch (de-de), English (GB) (en-gb), English (US) (en-us), Español (es-es), Français (fr-fr), Magyar (hu-hu), Italiano (it-it), Русский (ru-ru), and Slovenčina (sk-sk). --- ## Installation Instructions -### 1. Download the Extension -Download the latest **Playful Sparkle - COD fee** release from this repository. +### Installation Instructions for OpenCart 3.x+ -### 2. Upload the Extension Files -1. Log in to your OpenCart admin panel. -2. Navigate to `Extensions > Installer`. -3. Click the `Upload` button and upload the `ps_cod_fee.ocmod.zip` file. +1. Download the latest version from this repository. +2. Log in to your OpenCart admin panel. +3. Navigate to `Extensions > Installer`. +4. Click the `Upload` button and upload the `ps_cod_fee.ocmod.zip` file. +5. Navigate to `Extensions > Extensions` and select `Order Totals` from the `Choose the extension type` dropdown list. +6. Locate the extension in the `Order Totals` list and click the `Install` button. +7. Click the `Edit` button, configure the extension parameters, and click the `Save` button to save your settings. -### 3. Install the Extension -4. Once uploaded click on the green `Install` button -1. Then navigate to `Extensions` and select `Order Totals` from the dropdown. -2. Locate the **Playful Sparkle - COD fee** extension in the list. -3. Click on the green `Install` button. +### Installation Instructions for OpenCart 4.x+ -### 4. Configure the Extension -1. After installation, remain in the `Extensions` page and ensure `Order Totals` is selected from the dropdown. -2. Click the `Edit` button next to the installed extension. -3. Enter the amount, and setup other settings as per your store's requirements. -4. Save your configuration. +1. Download the latest version from this repository. +2. Log in to your OpenCart admin panel. +3. Navigate to `Extensions > Installer`. +4. Click the `Upload` button and upload the `ps_cod_fee.ocmod.zip` file. +5. Locate the extension in the `Installed Extensions` list and click the `Install` button. +6. Navigate to `Extensions > Extensions` and select `Order Totals` from the `Choose the extension type` dropdown list. +7. Locate the extension in the `Order Totals` list and click the `Install` button. +8. Click the `Edit` button, configure the extension parameters, and click the `Save` button to save your settings. --- -## Support & feedback +## Support & Inquiries -For support or any inquiries regarding the extensions, feel free to open an issue on this repository or reach out via email at `support@playfulsparkle.com`. +For assistance or inquiries related to this extension, please open an issue on this repository or contact us via email at [support@playfulsparkle.com](mailto:support@playfulsparkle.com). --- ## License -This project is licensed under the GPL-3.0 license. See the [LICENSE](./LICENSE) file for more information. +This project is distributed under the GPL-3.0 license. Please refer to the [LICENSE](./LICENSE) file for further details. --- ## Contributing -We welcome contributions! If you would like to contribute to this project, please fork the repository and submit a pull request with your changes. +We encourage contributions from the community. To contribute, please fork the repository and submit a pull request with your proposed changes. diff --git a/compress.js b/compress.js index a91648c..e02b9c9 100644 --- a/compress.js +++ b/compress.js @@ -29,5 +29,6 @@ archive.pipe(output); archive.directory("src/upload/", "upload"); archive.file("src/install.xml", { name: "install.xml" }); +archive.file("src/installation.txt", { name: "installation.txt" }); archive.finalize(); diff --git a/src/installation.txt b/src/installation.txt index be77512..ae15442 100644 --- a/src/installation.txt +++ b/src/installation.txt @@ -1,49 +1,41 @@ Playful Sparkle - COD fee -Enhance your checkout process with our Playful Sparkle - COD fee for OpenCart 3.x. This extension automatically adds a customizable fee to the order total when customers select the "Cash on Delivery" payment option during checkout. - -For more information, visit the extension GitHub page at https://github.com/playfulsparkle/oc3_cod_fee.git. - -Demo frontend - https://opencart3.playfulsparkle.com/ -Demo backend - https://opencart3.playfulsparkle.com/admin/ - -Key Features - -* Automatically adds a customizable fee when customers choose Cash on Delivery (COD) at checkout. -* Choose between different fee configurations: fixed amounts to be added to the total order cost. -* Effortless setup and management through the OpenCart admin interface. -* Fully compatible with OpenCart 3.x. -* Multilingual Support: The extension is available in the following languages: - * Čeština (cs-cz) - * Deutsch (de-de) - * English (GB) (en-gb) - * English (US) (en-us) - * Español (es-es) - * Français (fr-fr) - * Magyar (hu-hu) - * Italiano (it-it) - * Русский (ru-ru) - * Slovenčina (sk-sk) - -Installation Guide - -1. Download the "Playful Sparkle - COD fee" Extension Package. -2. Download the latest version of the Playful Sparkle - COD fee extension from the link provided on this page. -3. Upload the Extension Files: - 1. Log in to your OpenCart admin panel. - 2. Navigate to Extensions > Installer. - 3. Click the "Upload" button and upload the file codfee.ocmod.zip. -4. Install the Extension: - 1. After uploading, click the green "Install" button. - 2. Go to Extensions and select Order Totals from the dropdown menu. - 3. Locate the "Playful Sparkle - COD fee" extension in the list. - 4. Click the green "Install" button to activate it. -5. Configure the Extension: - 1. Stay on the Extensions page with Order Totals selected. - 2. Click the "Edit" button next to the installed Playful Sparkle - COD fee extension. - 3. Input your preferred fee amount and adjust other settings to suit your store’s requirements. - 4. Save your configuration. - -Support & Feedback - -For support or any inquiries regarding the extension, feel free to open an issue on this repository or reach out via email at support@playfulsparkle.com. +The Playful Sparkle - COD fee extension for OpenCart 3.x+ allows store owners to easily add a customizable fee when customers choose Cash on Delivery (COD) as their payment method. Designed to streamline the payment process, it ensures accurate handling of cash on delivery fees directly within checkout. This extension helps cover transaction costs for businesses, enhancing the overall checkout experience by transparently including the fee where applicable. Perfect for e-commerce businesses of all sizes, it requires no technical expertise to set up and integrates seamlessly with OpenCart 3.x+. + +Features + +- Configurable fee options: A fixed amount can be added to the total order value. +- Compatibility: Integrates smoothly with OpenCart 3.x+, supporting a range of online store setups. +- Multilingual Support: Ready for international use with languages including Čeština (cs-cz), Deutsch (de-de), English (GB) (en-gb), English (US) (en-us), Español (es-es), Français (fr-fr), Magyar (hu-hu), Italiano (it-it), Русский (ru-ru), and Slovenčina (sk-sk). + +For more information, visit the extension's GitHub page at https://github.com/playfulsparkle/oc3_cod_fee.git. + +Demo frontend: https://opencart3.playfulsparkle.com/ +Demo backend: https://opencart3.playfulsparkle.com/admin/ + +Installation Instructions + +Installation Instructions for OpenCart 3.x+ + +1. Download the latest version from this repository. +2. Log in to your OpenCart admin panel. +3. Navigate to Extensions > Installer. +4. Click the Upload button and upload the ps_cod_fee.ocmod.zip file. +5. Navigate to Extensions > Extensions and select Order Totals from the Choose the extension type dropdown list. +6. Locate the extension in the Order Totals list and click the Install button. +7. Click the Edit button, configure the extension parameters, and click the Save button to save your settings. + +Installation Instructions for OpenCart 4.x+ + +1. Download the latest version from this repository. +2. Log in to your OpenCart admin panel. +3. Navigate to Extensions > Installer. +4. Click the Upload button and upload the ps_cod_fee.ocmod.zip file. +5. Locate the extension in the Installed Extensions list and click the Install button. +6. Navigate to Extensions > Extensions and select Order Totals from the Choose the extension type dropdown list. +7. Locate the extension in the Order Totals list and click the Install button. +8. Click the Edit button, configure the extension parameters, and click the Save button to save your settings. + +Support & Inquiries + +For assistance or inquiries related to this extension, please open an issue on this repository or contact us via email at support@playfulsparkle.com.