Skip to content

Commit 1f3ef16

Browse files
authored
Merge pull request #1573 from algolia/bugfix/MAGE-950
MAGE-950: readme.md updated.
2 parents 8e68283 + 705a884 commit 1f3ef16

File tree

1 file changed

+18
-30
lines changed

1 file changed

+18
-30
lines changed

README.md

Lines changed: 18 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,14 @@ Try the autocomplete and the instantsearch results page on our [live demo](https
3131

3232
## Magento 2.4 compatibility & extension versions End of Life
3333

34-
We are happy to announce that version 3.x of our extension is now compatible with Magento 2.4. Review the [Customisation](https://github.com/algolia/algoliasearch-magento-2#customisation) section to learn more about the differences between our extension versions.
34+
Magento 2.3 and earlier versions are no longer supported by the Algolia extension.
3535

36-
The 1.x and 2.x versions of the extension are now End of Life (EOL). We no longer accept community PRs for those branches.
36+
Version 3.x of our extension is compatible with Magento 2.4. Review the [Customisation](https://github.com/algolia/algoliasearch-magento-2#customisation) section to learn more about the differences between our extension versions.
3737

38-
| Extension Version | End of Life |
39-
| --- | --- |
40-
| v1.x | Dec 2020 |
41-
| v2.x | Dec 2020 |
42-
| v3.x | N/A |
38+
| Extension Version | End of Life | Magento | PHP |
39+
|-------------------| --- |----------| ---------|
40+
| v3.13.x | N/A | `2.4.x` | `^7.2 \|\| ^8.0` |
41+
| v3.14.x | N/A | `2.4.x` | `>=8.1` |
4342

4443
## Documentation
4544

@@ -55,13 +54,9 @@ The 1.x and 2.x versions of the extension are now End of Life (EOL). We no longe
5554

5655
The easiest way to install the extension is to use [Composer](https://getcomposer.org/) and follow our [getting started guide](https://www.algolia.com/doc/integration/magento-2/getting-started/quick-start/).
5756

58-
### Upgrading from 1.x to 2.x
57+
If you would like to stay on a minor version, please upgrade your composer to only accept minor versions. The following example will keep you on the minor version and will update patches automatically.
5958

60-
With the release of a new major version, we have decided to create minor and major version releases to allow those that want to continue on the minor version. This update will **break compatibility**. Please read the [upgrade guide](https://www.algolia.com/doc/integration/magento-2/getting-started/upgrading/#upgrading-from-v1-to-v2) for all of the file changes and updates included in this release.
61-
62-
If you would like to stay on a minor version, please upgrade your composer to only accept versions less than version 2 like the example:
63-
64-
`"algolia/algoliasearch-magento-2": "3.12.0"`
59+
`"algolia/algoliasearch-magento-2": "~3.14.0"`
6560

6661
### Customisation
6762

@@ -74,22 +69,16 @@ Please check our [Custom Extension](https://github.com/algolia/algoliasearch-cus
7469

7570
Knowing the version of the library will help you understand what is available in these libraries for you to leverage in terms of customisation. This table will help you determine which documentation to reference when you start working on your customisation.
7671

77-
| Extension Version | autocomplete.js | instantsearch.js | search-insights.js | recommend.js |
78-
|-----------------|-------------------------------------------------------------------|--------------------------------------------------------------------| --- | --- |
79-
| v1.x | [0.26.0](https://github.com/algolia/autocomplete.js/tree/v0.26.0) | [2.10.2](https://github.com/algolia/instantsearch.js/tree/v2.10.2) | [0.0.14](https://cdn.jsdelivr.net/npm/[email protected]) | NA |
80-
| v2.x | [0.38.0](https://github.com/algolia/autocomplete.js/tree/v0.38.0) | [4.7.2](https://github.com/algolia/instantsearch.js/tree/v4.7.2) | [1.4.0](https://github.com/algolia/search-insights.js/tree/v1.4.0) | NA |
72+
| Extension Version | autocomplete.js | instantsearch.js | search-insights.js | recommend.js |
73+
|-------------------|-------------------------------------------------------------------|--------------------------------------------------------------------| --- |-------------------------------------------------------------|
8174
| v3.x | [0.38.0](https://github.com/algolia/autocomplete.js/tree/v0.38.0) | [4.15.0](https://github.com/algolia/instantsearch.js/tree/v4.15.0) | [1.7.1](https://github.com/algolia/search-insights.js/tree/v1.7.1) | NA |
8275
| v3.9.1 | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3) | [4.41.0](https://github.com/algolia/instantsearch.js/tree/v4.41.0) | [1.7.1](https://github.com/algolia/search-insights.js/tree/v1.7.1) | [1.5.0](https://github.com/algolia/recommend/tree/v1.5.0) |
8376
| v3.10.x | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3) | [4.41.0](https://github.com/algolia/instantsearch.js/tree/v4.41.0) | [1.7.1](https://github.com/algolia/search-insights.js/tree/v1.7.1) | [1.8.0](https://github.com/algolia/recommend/tree/v1.8.0) |
8477
| v3.11.0 | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3) | [4.41.0](https://github.com/algolia/instantsearch.js/tree/v4.41.0) | [2.6.0](https://github.com/algolia/search-insights.js/tree/v2.6.0) | [1.8.0](https://github.com/algolia/recommend/tree/v1.8.0) |
85-
| >=v3.13.0 | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3) | [4.63.0](https://github.com/algolia/instantsearch/tree/instantsearch.js%404.63.0) | [2.6.0](https://github.com/algolia/search-insights.js/tree/v2.6.0) | [1.8.0](https://github.com/algolia/recommend/tree/v1.8.0) |
86-
87-
78+
| v3.13.0 | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3) | [4.63.0](https://github.com/algolia/instantsearch/tree/instantsearch.js%404.63.0) | [2.6.0](https://github.com/algolia/search-insights.js/tree/v2.6.0) | [1.8.0](https://github.com/algolia/recommend/tree/v1.8.0) |
79+
| >=v3.14.x | [1.6.3](https://github.com/algolia/autocomplete.js/tree/v1.6.3) | [4.63.0](https://github.com/algolia/instantsearch/tree/instantsearch.js%404.63.0) | [2.6.0](https://github.com/algolia/search-insights.js/tree/v2.6.0) | [1.15.0](https://github.com/algolia/recommend/tree/v1.15.0) |
8880
The autocomplete and instantsearch libraries are accessible in the `algoliaBundle` global. This bundle is a prepackage javascript file that contains it's dependencies. What is included in this bundle can be seen here:
8981

90-
v1.x latest bundle: https://github.com/algolia/algoliasearch-extensions-bundle/blob/ISv2/package.json \
91-
v2.x latest bundle: https://github.com/algolia/algoliasearch-extensions-bundle/blob/ISv4/package.json
92-
9382
The search-insights.js library is standalone.
9483

9584
Refer to these docs when customising your Algolia Magento extension frontend features:
@@ -103,13 +92,12 @@ The extension does most of the heavy lifting when it comes to gathering and prep
10392

10493
Depending on the extension version you are using, you could have a different PHP API client version powering the extension's backend functionality.
10594

106-
| Extension Version | API Client Version |
107-
|-------------------|---------------------------------------------------------------------------|
108-
| v1.x | [1.28.0](https://github.com/algolia/algoliasearch-client-php/tree/1.28.0) |
109-
| v2.x | [2.5.1](https://github.com/algolia/algoliasearch-client-php/tree/2.5.1) |
110-
| v3.x | [2.5.1](https://github.com/algolia/algoliasearch-client-php/tree/2.5.1) |
111-
| v3.6.x | [3.2.0](https://github.com/algolia/algoliasearch-client-php/tree/3.2.0) |
112-
| >= v3.11.0 | [3.3.2](https://github.com/algolia/algoliasearch-client-php/tree/3.3.2) |
95+
| Extension Version | API Client Version |
96+
|-------------------|-------------------------------------------------------------------------|
97+
| v3.x | [2.5.1](https://github.com/algolia/algoliasearch-client-php/tree/2.5.1) |
98+
| v3.6.x | [3.2.0](https://github.com/algolia/algoliasearch-client-php/tree/3.2.0) |
99+
| v3.11.0 | [3.3.2](https://github.com/algolia/algoliasearch-client-php/tree/3.3.2) |
100+
| >=v3.14.x | [4.0.x](https://github.com/algolia/algoliasearch-client-php/tree/4.0.0-beta.12) |
113101

114102
Refer to these docs when customising your Algolia Magento extension backend:
115103
- [Indexing](https://www.algolia.com/doc/integration/magento-2/how-it-works/indexing/)

0 commit comments

Comments
 (0)