From 21847a7a6235d890a0b0a8d08a3e906730738283 Mon Sep 17 00:00:00 2001 From: Vasilii Burlacu Date: Fri, 27 May 2022 12:12:14 +0300 Subject: [PATCH] Update README.md --- README.md | 42 +++++++++++++++++++----------------------- 1 file changed, 19 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 0bd416c..ecf417d 100644 --- a/README.md +++ b/README.md @@ -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 @@ -10,30 +20,16 @@ ### Storefront coverage -| Luma-based | Hyva-based | -| ---------- |----------------| -| Partial support.
Only the Javascript part to fetch the data is present.
The products are not shown on the page | ✅ Full support | +| Luma-based | Hyva-based | +|------------------------------------------------------------------------------------------------------------------------|----------------| +| Partial support.
Only the Javascript part to fetch the data is present.
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