Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Vasilii Burlacu committed May 27, 2022
1 parent 03cdf4d commit 21847a7
Showing 1 changed file with 19 additions and 23 deletions.
42 changes: 19 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# ImaginationMedia_AlgoliaProductRecommendations

> Displays product recommendations from Algolia on the PDP
> Displays Algolia product recommendations on Product & Shopping Cart pages
## Installation

```bash
composer require imaginationmedia/algolia-product-recommendations &&

bin/magento m:e ImaginationMedia_AlgoliaProductRecommendations &&
bin/magento s:up &&
bin/magento c:f
```

### Prerequisites

Expand All @@ -10,30 +20,16 @@

### Storefront coverage

| Luma-based | Hyva-based |
| ---------- |----------------|
| Partial support.<br/>Only the Javascript part to fetch the data is present.<br/>The products are not shown on the page | Full support |
| Luma-based | Hyva-based |
|------------------------------------------------------------------------------------------------------------------------|----------------|
| Partial support.<br/>Only the Javascript part to fetch the data is present.<br/>The products are not shown on the page | :white_check_mark: Full support |

#### Luma-based

It all starts with
```
view/frontend/layout/catalog_product_view.xml
```
### Implementation Details

#### Hyva-based
For the **Product** page it's used the _Related Products_ Algolia Recommend model[^1].

It all starts with
```
view/frontend/layout/hyva_catalog_product_view.xml
```

## Installation
For the **Shopping Cart** page it's used the _Frequently Bought Together_ Algolia Recommend model[^2].

```bash
composer require imaginationmedia/algolia-product-recommendations &&

bin/magento m:e ImaginationMedia_AlgoliaProductRecommendations &&
bin/magento s:up &&
bin/magento c:f
```
[^1]: https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products
[^2]: https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together

0 comments on commit 21847a7

Please sign in to comment.