Skip to content

Commit dfda3f6

Browse files
committed
Readme.md update
1 parent 3e4d5a9 commit dfda3f6

File tree

1 file changed

+65
-41
lines changed

1 file changed

+65
-41
lines changed

README.md

Lines changed: 65 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,113 @@
1-
<p align="center"><img src="https://postcodeservice.com/wp-content/uploads/2021/01/postcode-service-logo__Logo-color.svg" width="300px" /></p>
2-
3-
# Postcode Service Magento 2
4-
[![Latest Stable Version](https://img.shields.io/github/v/release/tig-nl/postcode-magento2?style=for-the-badge&color=227cff)](https://github.com/postcodeservice/postcode-magento2/releases/latest)
5-
![TIG Postcode Service 2.3.7 versions](https://img.shields.io/badge/Tested%20with%20Magento-2.3.7-%2300cf00?style=for-the-badge)
1+
# Postcode Service Magento 2 extension
2+
[![Latest Stable Version](https://img.shields.io/github/v/release/postcodeservice/postcode-magento2?style=for-the-badge&color=227cff)](https://github.com/postcodeservice/postcode-magento2/releases/latest)
63
![TIG Postcode Service 2.4.6 versions](https://img.shields.io/badge/Tested%20with%20Magento-2.4.6-%2300cf00?style=for-the-badge)
4+
![TIG Postcode Service 2.4.5 versions](https://img.shields.io/badge/Tested%20with%20Magento-2.4.5-%2300cf00?style=for-the-badge)
5+
![TIG Postcode Service 2.4.4 versions](https://img.shields.io/badge/Tested%20with%20Magento-2.4.4-%2300cf00?style=for-the-badge)
76
[![Total Extension downloads](https://img.shields.io/packagist/dt/tig/postcode-magento2?style=for-the-badge&color=227cff)](https://packagist.org/packages/tig/postcode-magento2/stats)
8-
![Build Status](https://img.shields.io/travis/tig-nl/postcode-magento2/master?style=for-the-badge)
9-
10-
11-
## Requirements
12-
- Magento version 2.4.6, 2.4.5, 2.4.4, 2.3.7 or 2.3.6
13-
- PHP 7.3+
147

158
## Installation
16-
We strongly recommend that you use a Staging Environment for the installation, and to also make a backup of your environment.
9+
We strongly recommend that you use a staging environment for the installation, and to also make a backup of your environment.
1710

18-
### Installation using composer (recommended)
19-
To install the extension login to your environment using SSH. Then navigate to the Magento 2 root directory and run the following commands in the same order as described:
11+
### Installation using composer (Recommended)
12+
To install the extension login to your environment using SSH.
13+
Then navigate to the Magento 2 root directory and run the following commands in the same order as described:
2014

2115
Enable maintenance mode:
2216
~~~~shell
2317
php bin/magento maintenance:enable
2418
~~~~
2519

26-
1. Install the extension:
20+
Install the extension:
2721
~~~~shell
2822
composer require tig/postcode-magento2
2923
~~~~
3024

31-
2. Enable the Postcode Service Magento 2 extension
25+
Enable the Postcode Service Magento 2 extension
3226
~~~~shell
3327
php bin/magento module:enable TIG_Postcode
3428
~~~~
3529

36-
3. Update the Magento 2 environment:
30+
Update the Magento 2 environment:
3731
~~~~shell
3832
php bin/magento setup:upgrade
3933
~~~~
4034

41-
When your Magento environment is running in production mode, you also need to run the following comands:
35+
----------------------------------
36+
When your Magento environment is running in production mode, you also need to run the following commands:
4237

43-
4. Compile DI:
38+
Compile DI:
4439
~~~~shell
4540
php bin/magento setup:di:compile
4641
~~~~
4742

48-
5. Deploy static content:
43+
Deploy static content:
4944
~~~~shell
5045
php bin/magento setup:static-content:deploy
5146
~~~~
47+
----------------------------------
5248

53-
6. Disable maintenance mode:
49+
Disable maintenance mode:
5450
~~~~shell
5551
php bin/magento maintenance:disable
5652
~~~~
5753

58-
### Installation manually
59-
1. Download the extension directly from [github](https://github.com/postcodeservice/postcode-magento2) by clicking on *Code* and then *Download ZIP*.
60-
2. Create the directory *app/code/TIG/Postcode* (Case-sensitive)
61-
3. Extract the zip and upload the code into *app/code/TIG/Postcode*
62-
4. Enable the Postcode Service Magento 2 extension
54+
## How to update the extension
55+
To update the Postcode Service Extension run the following commands:
6356
~~~~shell
64-
php bin/magento module:enable TIG_Postcode
57+
composer update tig/postcode-magento2
58+
php bin/magento setup:upgrade
6559
~~~~
6660

67-
5. Update the Magento 2 environment:
61+
## Alternatively, install the extension manually
62+
- Download the extension directly from [github](https://github.com/postcodeservice/postcode-magento2) by clicking on *Code* and then *Download ZIP*.
63+
- Create the directory *app/code/TIG/Postcode* (Case-sensitive)
64+
- Extract the zip and upload the code into *app/code/TIG/Postcode*
65+
- Enable the Postcode Service Magento 2 extension
6866
~~~~shell
69-
php bin/magento setup:upgrade
67+
php bin/magento module:enable TIG_Postcode
7068
~~~~
71-
72-
## Update
73-
To update the Postcode Service Extension run the following commands:
69+
- Update the Magento 2 environment
7470
~~~~shell
75-
composer update tig/postcode-magento2
7671
php bin/magento setup:upgrade
7772
~~~~
7873

79-
## Examples
74+
## Configuration
75+
After completing the installation process, the extension should be readily available in the backend of your Magento webshop. From there, you can configure the extension according to your requirements:
76+
77+
1. Go to Stores -> Configuration -> Sales -> Postcode Service International
78+
79+
2. Open the Configuration tab
80+
81+
3. Change the Modus from "Off" to "Test" or "Live"
82+
83+
4. Insert your Client ID and Api key (Secure Code). When you selected “Test” at the Modus, you can find test credentials below the fields - keep in mind there is a daily limit -.\
84+
To sign up for a paid account and get your Client ID and Api key, simply visit https://postcodeservice.com and subscribe.
85+
86+
5. In the 'Countries' section, select the country for which you wish to enable the Postcode Service.
87+
6. Flush your cache
8088

81-
### Dutch Postcode Service within the Magento 2 checkout
82-
![Postcode Service Magento 2 Checkout NL](https://postcodeservice.com/wp-content/uploads/2022/08/postcodeservice-magento-2-nl.gif "Postcode Service Magento 2 Checkout NL")
89+
## Visual representation of the Postcode Service Magento extension during the checkout process
90+
### For Dutch postcodes
91+
<img src="https://postcodeservice.com/wp-content/uploads/2022/08/postcodeservice-magento-2-nl.gif" width="50%">
92+
93+
### For Belgium postcodes
94+
<img src="https://postcodeservice.com/wp-content/uploads/2022/08/postcodeservice-magento-2-be.gif" width="50%">
95+
96+
## Further documentation
97+
You can find the underlying Postcode Service API documentation here: https://developers.postcodeservice.com
98+
99+
## Frequently Asked Questions
100+
Q: What are the costs for using the Postcode Service?\
101+
A: The Adobe Magento extension can be used free of charge. The fee for using the Postcode Service can be found at our website https://postcodeservice.com
102+
\
103+
Q: Which third party extensions are supported and compatible?\
104+
A: At this time, we do not support third-party checkout extensions, including OneStepCheckout.com, Amasty, and MagePlaza. While we understand the importance of these third party extensions for some webshops, we cannot guarantee their compatibility with our extension and therefore cannot provide support for any issues that may arise as a result of their use. We have received reports from some users about compatibility issues with OneStepCheckout and MagePlaza, but this experience may vary from agency to agency, depending on the custom implementations. However, we are constantly working to improve our extension's functionality and compatibility, and we may revisit this decision in the future.
105+
106+
## Requirements
107+
Adobe Magento Open Source (Community edition) or Adobe Commerce (Enterprise version).
83108

84-
### Belgium Postcode Service within the Magento 2 checkout
85-
![Postcode Service Magento 2 Checkout BE](https://postcodeservice.com/wp-content/uploads/2022/08/postcodeservice-magento-2-be.gif "Postcode Service Magento 2 Checkout NL")
109+
## Version support
110+
We follow the release support lines dates from Adobe https://experienceleague.adobe.com/docs/commerce-operations/release/versions.html for the version support of this extension.
86111

87-
## Documentation
88-
For further installation guidance
89-
https://developers.postcodeservice.com/
112+
## Release history
113+
See https://github.com/postcodeservice/postcode-magento2/releases

0 commit comments

Comments
 (0)