From e8306de55a74fe3a67144b7d404fb6d513f9f263 Mon Sep 17 00:00:00 2001 From: Lachlan Turner Date: Tue, 28 Jun 2022 12:03:19 +0930 Subject: [PATCH] BEG-81: Update readme to include additional index information --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 67b9b6a..bb31471 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ # magento2-prerender-io -Provides integration between Magento 2 and [Prerender.io](https://prerender.io), giving the ability for product pages to be automatically recached when a product is updated. +Provides integration between Magento 2 and [Prerender.io](https://prerender.io), giving the ability for pages to be automatically recached when required. ## Overview -This module provides a new indexer, `prerender_io_product`, which will send URL recache requests to Prerender.io (in batches of up to 1000) when changes are made to products. -This will ensure that the cache product pages are kept up-to-date at all times. +This module provides new indexers: + +- `prerender_io_product`, which will send URL recache requests for products to Prerender.io (in batches of up to 1000) when changes are made to products. +- `prerender_io_category`, which will send URL recache requests for categories to Prerender.io (in batches of up to 1000) when changes are made to categories. +- `prerender_io_category_product`, which will send URL recache requests for categories to Prerender.io (in batches of up to 1000) when changes are made to products. + +These will ensure that the cached pages are kept up-to-date at all times. ## Installation To install via composer, simply run: @@ -12,12 +17,12 @@ To install via composer, simply run: composer require aligent/magento2-prerender-io ``` -Then, ensure the module is installed and the index is set to `Schedule`: +Then, ensure the module is installed and the indexers are set to `Schedule`: ```bash bin/magento module:enable Aligent_PrerenderIo bin/magento setup:upgrade -bin/magento indexer:set-mode schedule prerender_io_product +bin/magento indexer:set-mode schedule prerender_io_product prerender_io_category prerender_io_category_product ``` ## Configuration