chore(javascript): update READMEs (generated)

algolia/api-clients-automation#3829 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
algolia · Sep 25, 2024 · aa756bc · aa756bc
1 parent 173f86c
commit aa756bc
Show file tree

Hide file tree

Showing 11 changed files with 161 additions and 66 deletions.
diff --git a/README.md b/README.md
@@ -32,24 +32,35 @@
 
 ## 💡 Getting Started
 
-To get started, you first need to install algoliasearch (or any other available API client package).
 
+To get started, you first need to install algoliasearch (or any other available API client package).
 All of our clients comes with type definition, and are available for both browser and node environments.
 
+### With a package manager
+
+
 ```bash
-yarn add algoliasearch
+yarn add algoliasearch@5.6.0
 # or
-npm install algoliasearch
+npm install algoliasearch@5.6.0
+# or
+pnpm add algoliasearch@5.6.0
 ```
 
-Without a package manager
+### Without a package manager
 
 Add the following JavaScript snippet to the <head> of your website:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/algoliasearch.umd.min.js"></script>
+// for the full client
+<script src="https://cdn.jsdelivr.net/npm/algoliasearch@5.6.0/dist/algoliasearch.umd.js"></script>
+
+// for the lite client
+<script src="https://cdn.jsdelivr.net/npm/algoliasearch@5.6.0/dist/lite/builds/browser.umd.js"></script>
 ```
 
+### Usage
+
 You can now import the Algolia API client in your project and play with it.
 
 ```js
@@ -63,7 +74,7 @@ import { liteClient } from 'algoliasearch/lite';
 const client = liteClient('YOUR_APP_ID', 'YOUR_API_KEY');
 ```
 
-For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
+For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/search/)**.
 
 ## ❓ Troubleshooting
 

diff --git a/packages/algoliasearch/README.md b/packages/algoliasearch/README.md
@@ -32,24 +32,35 @@
 
 ## 💡 Getting Started
 
-To get started, you first need to install algoliasearch (or any other available API client package).
 
+To get started, you first need to install algoliasearch (or any other available API client package).
 All of our clients comes with type definition, and are available for both browser and node environments.
 
+### With a package manager
+
+
 ```bash
-yarn add algoliasearch
+yarn add algoliasearch@5.6.0
 # or
-npm install algoliasearch
+npm install algoliasearch@5.6.0
+# or
+pnpm add algoliasearch@5.6.0
 ```
 
-Without a package manager
+### Without a package manager
 
 Add the following JavaScript snippet to the <head> of your website:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/algoliasearch.umd.min.js"></script>
+// for the full client
+<script src="https://cdn.jsdelivr.net/npm/algoliasearch@5.6.0/dist/algoliasearch.umd.js"></script>
+
+// for the lite client
+<script src="https://cdn.jsdelivr.net/npm/algoliasearch@5.6.0/dist/lite/builds/browser.umd.js"></script>
 ```
 
+### Usage
+
 You can now import the Algolia API client in your project and play with it.
 
 ```js
@@ -63,7 +74,7 @@ import { liteClient } from 'algoliasearch/lite';
 const client = liteClient('YOUR_APP_ID', 'YOUR_API_KEY');
 ```
 
-For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
+For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/search/)**.
 
 ## ❓ Troubleshooting
 

diff --git a/packages/client-abtesting/README.md b/packages/client-abtesting/README.md
@@ -32,24 +32,33 @@
 
 ## 💡 Getting Started
 
-To get started, you first need to install @algolia/client-abtesting (or any other available API client package).
+> [!TIP]
+> This API client is already a dependency of [the algoliasearch client](https://www.npmjs.com/package/algoliasearch), you don't need to manually install `@algolia/client-abtesting` if you already have `algoliasearch` installed.
 
+To get started, you first need to install @algolia/client-abtesting (or any other available API client package).
 All of our clients comes with type definition, and are available for both browser and node environments.
 
+### With a package manager
+
+
 ```bash
-yarn add @algolia/client-abtesting
+yarn add @algolia/client-abtesting@5.6.0
+# or
+npm install @algolia/client-abtesting@5.6.0
 # or
-npm install @algolia/client-abtesting
+pnpm add @algolia/client-abtesting@5.6.0
 ```
 
-Without a package manager
+### Without a package manager
 
 Add the following JavaScript snippet to the <head> of your website:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-abtesting.umd.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@algolia/client-abtesting@5.6.0/dist/builds/browser.umd.js"></script>
 ```
 
+### Usage
+
 You can now import the Algolia API client in your project and play with it.
 
 ```js
@@ -58,7 +67,7 @@ import { abtestingClient } from '@algolia/client-abtesting';
 const client = abtestingClient('YOUR_APP_ID', 'YOUR_API_KEY');
 ```
 
-For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
+For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/abtesting/)**.
 
 ## ❓ Troubleshooting
 

diff --git a/packages/client-analytics/README.md b/packages/client-analytics/README.md
@@ -32,24 +32,33 @@
 
 ## 💡 Getting Started
 
-To get started, you first need to install @algolia/client-analytics (or any other available API client package).
+> [!TIP]
+> This API client is already a dependency of [the algoliasearch client](https://www.npmjs.com/package/algoliasearch), you don't need to manually install `@algolia/client-analytics` if you already have `algoliasearch` installed.
 
+To get started, you first need to install @algolia/client-analytics (or any other available API client package).
 All of our clients comes with type definition, and are available for both browser and node environments.
 
+### With a package manager
+
+
 ```bash
-yarn add @algolia/client-analytics
+yarn add @algolia/client-analytics@5.6.0
+# or
+npm install @algolia/client-analytics@5.6.0
 # or
-npm install @algolia/client-analytics
+pnpm add @algolia/client-analytics@5.6.0
 ```
 
-Without a package manager
+### Without a package manager
 
 Add the following JavaScript snippet to the <head> of your website:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-analytics.umd.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@algolia/client-analytics@5.6.0/dist/builds/browser.umd.js"></script>
 ```
 
+### Usage
+
 You can now import the Algolia API client in your project and play with it.
 
 ```js
@@ -58,7 +67,7 @@ import { analyticsClient } from '@algolia/client-analytics';
 const client = analyticsClient('YOUR_APP_ID', 'YOUR_API_KEY');
 ```
 
-For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
+For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/analytics/)**.
 
 ## ❓ Troubleshooting
 

diff --git a/packages/client-insights/README.md b/packages/client-insights/README.md
@@ -32,24 +32,31 @@
 
 ## 💡 Getting Started
 
-To get started, you first need to install @algolia/client-insights (or any other available API client package).
 
+To get started, you first need to install @algolia/client-insights (or any other available API client package).
 All of our clients comes with type definition, and are available for both browser and node environments.
 
+### With a package manager
+
+
 ```bash
-yarn add @algolia/client-insights
+yarn add @algolia/client-insights@5.6.0
+# or
+npm install @algolia/client-insights@5.6.0
 # or
-npm install @algolia/client-insights
+pnpm add @algolia/client-insights@5.6.0
 ```
 
-Without a package manager
+### Without a package manager
 
 Add the following JavaScript snippet to the <head> of your website:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-insights.umd.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@algolia/client-insights@5.6.0/dist/builds/browser.umd.js"></script>
 ```
 
+### Usage
+
 You can now import the Algolia API client in your project and play with it.
 
 ```js
@@ -58,7 +65,7 @@ import { insightsClient } from '@algolia/client-insights';
 const client = insightsClient('YOUR_APP_ID', 'YOUR_API_KEY');
 ```
 
-For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
+For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/insights/)**.
 
 ## ❓ Troubleshooting
 

diff --git a/packages/client-personalization/README.md b/packages/client-personalization/README.md
@@ -32,24 +32,33 @@
 
 ## 💡 Getting Started
 
-To get started, you first need to install @algolia/client-personalization (or any other available API client package).
+> [!TIP]
+> This API client is already a dependency of [the algoliasearch client](https://www.npmjs.com/package/algoliasearch), you don't need to manually install `@algolia/client-personalization` if you already have `algoliasearch` installed.
 
+To get started, you first need to install @algolia/client-personalization (or any other available API client package).
 All of our clients comes with type definition, and are available for both browser and node environments.
 
+### With a package manager
+
+
 ```bash
-yarn add @algolia/client-personalization
+yarn add @algolia/client-personalization@5.6.0
+# or
+npm install @algolia/client-personalization@5.6.0
 # or
-npm install @algolia/client-personalization
+pnpm add @algolia/client-personalization@5.6.0
 ```
 
-Without a package manager
+### Without a package manager
 
 Add the following JavaScript snippet to the <head> of your website:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-personalization.umd.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@algolia/client-personalization@5.6.0/dist/builds/browser.umd.js"></script>
 ```
 
+### Usage
+
 You can now import the Algolia API client in your project and play with it.
 
 ```js
@@ -58,7 +67,7 @@ import { personalizationClient } from '@algolia/client-personalization';
 const client = personalizationClient('YOUR_APP_ID', 'YOUR_API_KEY');
 ```
 
-For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
+For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/personalization/)**.
 
 ## ❓ Troubleshooting
 

diff --git a/packages/client-query-suggestions/README.md b/packages/client-query-suggestions/README.md
@@ -32,24 +32,31 @@
 
 ## 💡 Getting Started
 
-To get started, you first need to install @algolia/client-query-suggestions (or any other available API client package).
 
+To get started, you first need to install @algolia/client-query-suggestions (or any other available API client package).
 All of our clients comes with type definition, and are available for both browser and node environments.
 
+### With a package manager
+
+
 ```bash
-yarn add @algolia/client-query-suggestions
+yarn add @algolia/client-query-suggestions@5.6.0
+# or
+npm install @algolia/client-query-suggestions@5.6.0
 # or
-npm install @algolia/client-query-suggestions
+pnpm add @algolia/client-query-suggestions@5.6.0
 ```
 
-Without a package manager
+### Without a package manager
 
 Add the following JavaScript snippet to the <head> of your website:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-query-suggestions.umd.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@algolia/client-query-suggestions@5.6.0/dist/builds/browser.umd.js"></script>
 ```
 
+### Usage
+
 You can now import the Algolia API client in your project and play with it.
 
 ```js
@@ -58,7 +65,7 @@ import { querySuggestionsClient } from '@algolia/client-query-suggestions';
 const client = querySuggestionsClient('YOUR_APP_ID', 'YOUR_API_KEY');
 ```
 
-For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
+For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/query-suggestions/)**.
 
 ## ❓ Troubleshooting
 

diff --git a/packages/client-search/README.md b/packages/client-search/README.md
@@ -32,24 +32,33 @@
 
 ## 💡 Getting Started
 
-To get started, you first need to install @algolia/client-search (or any other available API client package).
+> [!TIP]
+> This API client is already a dependency of [the algoliasearch client](https://www.npmjs.com/package/algoliasearch), you don't need to manually install `@algolia/client-search` if you already have `algoliasearch` installed.
 
+To get started, you first need to install @algolia/client-search (or any other available API client package).
 All of our clients comes with type definition, and are available for both browser and node environments.
 
+### With a package manager
+
+
 ```bash
-yarn add @algolia/client-search
+yarn add @algolia/client-search@5.6.0
+# or
+npm install @algolia/client-search@5.6.0
 # or
-npm install @algolia/client-search
+pnpm add @algolia/client-search@5.6.0
 ```
 
-Without a package manager
+### Without a package manager
 
 Add the following JavaScript snippet to the <head> of your website:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-search.umd.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.6.0/dist/builds/browser.umd.js"></script>
 ```
 
+### Usage
+
 You can now import the Algolia API client in your project and play with it.
 
 ```js
@@ -58,7 +67,7 @@ import { searchClient } from '@algolia/client-search';
 const client = searchClient('YOUR_APP_ID', 'YOUR_API_KEY');
 ```
 
-For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
+For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/search/)**.
 
 ## ❓ Troubleshooting