diff --git a/README.md b/README.md index a3f52d4af..ad66decbc 100644 --- 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 of your website: ```html - +// for the full client + + +// for the lite client + ``` +### 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 index a3f52d4af..ad66decbc 100644 --- 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 of your website: ```html - +// for the full client + + +// for the lite client + ``` +### 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 index aedf496b0..8b3cab568 100644 --- 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 of your website: ```html - + ``` +### 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 index 700147267..c966dd8f2 100644 --- 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 of your website: ```html - + ``` +### 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 index 1d01b735e..6cadd1a88 100644 --- 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 of your website: ```html - + ``` +### 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 index 933f76d47..7aedb6f78 100644 --- 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 of your website: ```html - + ``` +### 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 index 4c901066f..b35f851e4 100644 --- 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 of your website: ```html - + ``` +### 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 index 263aff615..36aefc01e 100644 --- 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 of your website: ```html - + ``` +### 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 diff --git a/packages/ingestion/README.md b/packages/ingestion/README.md index 10cab006f..f33142bfe 100644 --- a/packages/ingestion/README.md +++ b/packages/ingestion/README.md @@ -32,24 +32,31 @@ ## 💡 Getting Started -To get started, you first need to install @algolia/ingestion (or any other available API client package). +To get started, you first need to install @algolia/ingestion (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/ingestion +yarn add @algolia/ingestion@1.6.0 +# or +npm install @algolia/ingestion@1.6.0 # or -npm install @algolia/ingestion +pnpm add @algolia/ingestion@1.6.0 ``` -Without a package manager +### Without a package manager Add the following JavaScript snippet to the of your website: ```html - + ``` +### Usage + You can now import the Algolia API client in your project and play with it. ```js @@ -58,7 +65,7 @@ import { ingestionClient } from '@algolia/ingestion'; const client = ingestionClient('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/ingestion/)**. ## ❓ Troubleshooting diff --git a/packages/monitoring/README.md b/packages/monitoring/README.md index 2891cff00..2865c1315 100644 --- a/packages/monitoring/README.md +++ b/packages/monitoring/README.md @@ -32,24 +32,31 @@ ## 💡 Getting Started -To get started, you first need to install @algolia/monitoring (or any other available API client package). +To get started, you first need to install @algolia/monitoring (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/monitoring +yarn add @algolia/monitoring@1.6.0 +# or +npm install @algolia/monitoring@1.6.0 # or -npm install @algolia/monitoring +pnpm add @algolia/monitoring@1.6.0 ``` -Without a package manager +### Without a package manager Add the following JavaScript snippet to the of your website: ```html - + ``` +### Usage + You can now import the Algolia API client in your project and play with it. ```js @@ -58,7 +65,7 @@ import { monitoringClient } from '@algolia/monitoring'; const client = monitoringClient('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/monitoring/)**. ## ❓ Troubleshooting diff --git a/packages/recommend/README.md b/packages/recommend/README.md index 6159ffb77..fddfc3cea 100644 --- a/packages/recommend/README.md +++ b/packages/recommend/README.md @@ -32,24 +32,33 @@ ## 💡 Getting Started -To get started, you first need to install @algolia/recommend (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/recommend` if you already have `algoliasearch` installed. +To get started, you first need to install @algolia/recommend (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/recommend +yarn add @algolia/recommend@5.6.0 +# or +npm install @algolia/recommend@5.6.0 # or -npm install @algolia/recommend +pnpm add @algolia/recommend@5.6.0 ``` -Without a package manager +### Without a package manager Add the following JavaScript snippet to the of your website: ```html - + ``` +### Usage + You can now import the Algolia API client in your project and play with it. ```js @@ -58,7 +67,7 @@ import { recommendClient } from '@algolia/recommend'; const client = recommendClient('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/recommend/)**. ## ❓ Troubleshooting