diff --git a/Readme.md b/Readme.md index 5e87fd814b6e4112483d5e22dab82fd46e92b980..62bde8aa78ef4bafc214036b401fddf5ff6a01b6 100644 --- a/Readme.md +++ b/Readme.md @@ -23,17 +23,17 @@ Run the following command in Magento 2 root folder:</br> #### 1. Execute the following command to install the module: ``` -composer require uafrica/bobgo +composer require uafrica/customshipping ``` #### 2. Enter following commands to enable the module: ``` -php bin/magento module:enable uafrica_Customshipping -php bin/magento cache:clean -php bin/magento cache:flush -php bin/magento setup:upgrade -php bin/magento setup:di:compile -php bin/magento setup:static-content:deploy +bin/magento module:enable uafrica_Customshipping +bin/magento cache:clean +bin/magento cache:flush +bin/magento setup:upgrade +bin/magento setup:di:compile +bin/magento setup:static-content:deploy ``` @@ -41,23 +41,28 @@ php bin/magento setup:static-content:deploy 1. Download the extension zip file from the link below: </br> -<a href="https://github.com/uafrica/magento-uafrica-shipping-extension/archive/refs/heads/main.zip"> Download Magento 2 uAfrica Shipping Extension </a> + <a href="https://github.com/uafrica/magento-uafrica-shipping-extension/archive/refs/heads/main.zip"> Download Magento 2 uAfrica Shipping Extension </a> 2. Unzip the file and copy contents ->**{Magento root}**`/app/code/`**{Paste here}** + +3. Create `uafrica/Customshipping` <em>Directory</em> **It should look like this:** </br> >{Magento root}/app/code/uafrica/Customshipping/ -3. Go to Magento root folder and run upgrade `bin/magento setup:upgrade` command line to install `uafrica_Customshipping`: </br> + +>**{Magento root}**`/app/code/uafrica/Customshipping/`**{Paste here}** + + +3. Go to Magento root folder and run all commands below to install `uafrica_Customshipping`: </br> ``` -Bin/magento cache:clean +bin/magento cache:clean Bin/magento cache:flush Bin/magento setup:upgrade Bin/magento setup:di:compile ``` _____________________________________________________________________________________________________________________ -### After installation +# After installation ## How to configure Magento 2 uAfrica Shipping Extension @@ -69,41 +74,29 @@ Please visit [Bobgo](https://uafrica.co.za) to create an account. ### ✓ Step 2: Login to Magento Admin -1. Click on UAFRICA > bobGo > Enabled for Checkout > Yes </br> +1. Click on **UAFRICA** > bobGo > Enabled for Checkout > Yes </br> 2. and go to `Stores > Configuration > Sales > Delivery Methods` to configure the extension. -[//]: # (### ✓ Step 3: Configure Bobgo Shipping Extension) +### ✓ Step 3: Configure Bobgo Shipping Extension -[//]: # () -[//]: # (1. Select `Bobgo` as shipping method) + +1. Select `Bobgo` as shipping method [//]: # (2. Enter API key and API secret) -[//]: # (3. Select `Enable` to enable the extension) +2. Select `Enable` to enable the extension [//]: # (4. Select `Enable Debug Mode` to enable debug mode) -[//]: # (5. Click `Save Config`) - -[//]: # (6. Flush cache (System > Cache Management) and reindex (System > Index Management)) - -[//]: # (7. Clear generated files(`rm -rf var/generation/*`)) +1. Click `Save Config` -[//]: # (8. Reindex data (`php bin/magento indexer:reindex`)) - -[//]: # (9. Deploy static content (`php bin/magento setup:static-content:deploy`)) - -[//]: # (10. Run `php bin/magento cache:clean`) - -[//]: # (11. Run `php bin/magento cache:flush`) - -[//]: # (12. Run `php bin/magento setup:upgrade`) - -[//]: # (13. Run `php bin/magento setup:di:compile`) +[//]: # () +[//]: # (2. Flush cache (System > Cache Management) and reindex (System > Index Management) (might be optional)) -[//]: # (14. Run `php bin/magento setup:static-content:deploy`) +[//]: # () +[//]: # (3. Clear generated files(`rm -rf var/generation/*`)) ## How it works @@ -112,12 +105,11 @@ Please visit [Bobgo](https://uafrica.co.za) to create an account. ### ✓ Step 1: Add products to cart(Checkout) ->1. Add products to cart ->2. Go to checkout page ->3. Select shipping address ->4. BobGo will collect Shipping Rates that cart ->5. Select shipping method ->6. Place order +>1. Go to checkout page. +>2. Select shipping address. +>3. BobGo will collect **Shipping Rates** From various couriers. +>4. Select shipping method. +>5. Place order. ### ✓ Step 1: Create shipment (Admin) `Sales > Orders > View Order > Ship`