Skip to content

Commit d1f7536

Browse files
mrahman3177mrahman3177
committed
MAGE-950: readme.md updated.
1 parent 344499c commit d1f7536

File tree

1 file changed

+11
-34
lines changed

1 file changed

+11
-34
lines changed

‎README.md

Lines changed: 11 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,10 @@ Try the autocomplete and the instantsearch results page on our [live demo](https
3333

3434
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.
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.
37-
3836
| Extension Version | End of Life |
39-
| --- | --- |
40-
| v1.x | Dec 2020 |
41-
| v2.x | Dec 2020 |
42-
| v3.x | N/A |
37+
|-------------------| --- |
38+
| v3.13.x | N/A |
39+
| v3.14.x | N/A |
4340

4441
## Documentation
4542

@@ -55,14 +52,6 @@ The 1.x and 2.x versions of the extension are now End of Life (EOL). We no longe
5552

5653
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/).
5754

58-
### Upgrading from 1.x to 2.x
59-
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"`
65-
6655
### Customisation
6756

6857
The extension uses libraries to help assist with the frontend implementation for autocomplete, instantsearch, and insight features. It also uses the Algolia PHP client to leverage indexing and search methods from the backend. When you approach customisations for either, you have to understand that you are customising the implementation itself and not the components it is based on.
@@ -74,22 +63,13 @@ Please check our [Custom Extension](https://github.com/algolia/algoliasearch-cus
7463

7564
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.
7665

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 |
81-
| 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 |
82-
| 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) |
83-
| 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) |
84-
| 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-
66+
| Extension Version | autocomplete.js | instantsearch.js | search-insights.js | recommend.js |
67+
|-------------------|-------------------------------------------------------------------|--------------------------------------------------------------------| --- |-------------------------------------------------------------|
68+
| v3.13.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) | [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) |
69+
| 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) |
8770

8871
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:
8972

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-
9373
The search-insights.js library is standalone.
9474

9575
Refer to these docs when customising your Algolia Magento extension frontend features:
@@ -103,13 +83,10 @@ The extension does most of the heavy lifting when it comes to gathering and prep
10383

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

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) |
86+
| Extension Version | API Client Version | PHP | Magento |
87+
|-------------------|------------------------|------------------|-----------|
88+
| v3.13.x | [3.3.2](https://github.com/algolia/algoliasearch-client-php/tree/3.3.2) | `^7.2 \|\| ^8.0` | `2.4.x` |
89+
| v3.14.x | `4.0.x` | `>=8.1` | `2.4.x` |
11390

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

0 commit comments

Comments
 (0)