Skip to content

Commit

Permalink
BEG-81: Update readme to include additional index information
Browse files Browse the repository at this point in the history
  • Loading branch information
aligent-lturner committed Jun 28, 2022
1 parent 619bdbc commit e8306de
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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
Expand Down

0 comments on commit e8306de

Please sign in to comment.