From 9b4f553cebd4775cefc0b3e26f5323d9ef66541b Mon Sep 17 00:00:00 2001 From: Raed Date: Mon, 3 Jun 2024 16:10:47 +0200 Subject: [PATCH] fix: update the readme of js/react packages (#186) Co-authored-by: Haroen Viaene --- packages/recommend-js/README.md | 33 ++++++++++++++++++++++++++++++ packages/recommend-react/README.md | 27 ++++++++++++++++++++++++ 2 files changed, 60 insertions(+) diff --git a/packages/recommend-js/README.md b/packages/recommend-js/README.md index 84714745..620c3526 100644 --- a/packages/recommend-js/README.md +++ b/packages/recommend-js/README.md @@ -1,3 +1,36 @@ +> 🙌 From now on you can use Algolia Recommend from InstantSearch, simplifying your integration between the two libraries! +> +> Learn how to migrate following the [upgrade guide](https://www.algolia.com/doc/guides/algolia-recommend/upgrade/recommend-js/). + +```js +import instantsearch from 'instantsearch.js'; +import { + frequentlyBoughtTogether, + relatedProducts, +} from 'instantsearch.js/es/widgets'; +import algoliasearch from 'algoliasearch/lite'; +const searchClient = algoliasearch('YourApplicationID', 'YourSearchOnlyAPIKey'); + +instantsearch({ + // No need for a recommendClient anymore + searchClient, + indexName, +}).addWidgets([ + frequentlyBoughtTogether({ + container: '#frequentlyBoughtTogether', + objectIDs: [currentObjectID], + }), + relatedProducts({ + container: '#relatedProducts', + objectIDs: [currentObjectID], + }), +]); +``` + +--- +--- +--- + # `@algolia/recommend-js` JavaScript package for [Algolia Recommend](https://www.algolia.com/doc/guides/algolia-ai/recommend/). diff --git a/packages/recommend-react/README.md b/packages/recommend-react/README.md index 294d593f..29ca346b 100644 --- a/packages/recommend-react/README.md +++ b/packages/recommend-react/README.md @@ -1,3 +1,30 @@ +> 🙌 From now on you can use Algolia Recommend from InstantSearch, simplifying your integration between the two libraries! +> +> Learn how to migrate following the [upgrade guide](https://www.algolia.com/doc/guides/algolia-recommend/upgrade/recommend-react/). + +```jsx +import { + InstantSearch, + FrequentlyBoughtTogether, + RelatedProducts, +} from 'react-instantsearch'; +import algoliasearch from 'algoliasearch/lite'; +const searchClient = algoliasearch('YourApplicationID', 'YourSearchOnlyAPIKey'); + +function App() { + return ( + + + + + ); +} +``` + +--- +--- +--- + # `@algolia/recommend-react` React package for [Algolia Recommend](https://www.algolia.com/doc/guides/algolia-ai/recommend/).