fix: update the readme of js/react packages (#186)

Co-authored-by: Haroen Viaene <hello@haroen.me>
algolia · Jun 3, 2024 · 9b4f553 · 9b4f553
1 parent 8a3b8cc
commit 9b4f553
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 0 deletions.
diff --git 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
@@ -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 (
+    <InstantSearch searchClient={searchClient} indexName={indexName}>
+      <FrequentlyBoughtTogether objectIDs={[currentObjectID]} />
+      <RelatedProducts objectIDs={[currentObjectID]} />
+    </InstantSearch>
+  );
+}
+```
+
+---
+---
+---
+
 # `@algolia/recommend-react`
 
 React package for [Algolia Recommend](https://www.algolia.com/doc/guides/algolia-ai/recommend/).