Skip to content

Commit aa756bc

Browse files
algolia-botshortcuts
algolia-bot
and
shortcuts
committed
chore(javascript): update READMEs (generated)
algolia/api-clients-automation#3829 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
1 parent 173f86c commit aa756bc

File tree

11 files changed

+161
-66
lines changed

11 files changed

+161
-66
lines changed

‎README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,35 @@
3232

3333
## 💡 Getting Started
3434

35-
To get started, you first need to install algoliasearch (or any other available API client package).
3635

36+
To get started, you first need to install algoliasearch (or any other available API client package).
3737
All of our clients comes with type definition, and are available for both browser and node environments.
3838

39+
### With a package manager
40+
41+
3942
```bash
40-
yarn add algoliasearch
43+
yarn add algoliasearch@5.6.0
4144
# or
42-
npm install algoliasearch
45+
npm install [email protected]
46+
# or
47+
pnpm add [email protected]
4348
```
4449

45-
Without a package manager
50+
### Without a package manager
4651

4752
Add the following JavaScript snippet to the <head> of your website:
4853

4954
```html
50-
<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/algoliasearch.umd.min.js"></script>
55+
// for the full client
56+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/algoliasearch.umd.js"></script>
57+
58+
// for the lite client
59+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/lite/builds/browser.umd.js"></script>
5160
```
5261

62+
### Usage
63+
5364
You can now import the Algolia API client in your project and play with it.
5465

5566
```js
@@ -63,7 +74,7 @@ import { liteClient } from 'algoliasearch/lite';
6374
const client = liteClient('YOUR_APP_ID', 'YOUR_API_KEY');
6475
```
6576

66-
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
77+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/search/)**.
6778

6879
## ❓ Troubleshooting
6980

‎packages/algoliasearch/README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,35 @@
3232

3333
## 💡 Getting Started
3434

35-
To get started, you first need to install algoliasearch (or any other available API client package).
3635

36+
To get started, you first need to install algoliasearch (or any other available API client package).
3737
All of our clients comes with type definition, and are available for both browser and node environments.
3838

39+
### With a package manager
40+
41+
3942
```bash
40-
yarn add algoliasearch
43+
yarn add algoliasearch@5.6.0
4144
# or
42-
npm install algoliasearch
45+
npm install [email protected]
46+
# or
47+
pnpm add [email protected]
4348
```
4449

45-
Without a package manager
50+
### Without a package manager
4651

4752
Add the following JavaScript snippet to the <head> of your website:
4853

4954
```html
50-
<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/algoliasearch.umd.min.js"></script>
55+
// for the full client
56+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/algoliasearch.umd.js"></script>
57+
58+
// for the lite client
59+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/lite/builds/browser.umd.js"></script>
5160
```
5261

62+
### Usage
63+
5364
You can now import the Algolia API client in your project and play with it.
5465

5566
```js
@@ -63,7 +74,7 @@ import { liteClient } from 'algoliasearch/lite';
6374
const client = liteClient('YOUR_APP_ID', 'YOUR_API_KEY');
6475
```
6576

66-
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
77+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/search/)**.
6778

6879
## ❓ Troubleshooting
6980

‎packages/client-abtesting/README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,33 @@
3232

3333
## 💡 Getting Started
3434

35-
To get started, you first need to install @algolia/client-abtesting (or any other available API client package).
35+
> [!TIP]
36+
> 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.
3637
38+
To get started, you first need to install @algolia/client-abtesting (or any other available API client package).
3739
All of our clients comes with type definition, and are available for both browser and node environments.
3840

41+
### With a package manager
42+
43+
3944
```bash
40-
yarn add @algolia/client-abtesting
45+
yarn add @algolia/[email protected]
46+
# or
47+
npm install @algolia/[email protected]
4148
# or
42-
npm install @algolia/client-abtesting
49+
pnpm add @algolia/client-abtesting@5.6.0
4350
```
4451

45-
Without a package manager
52+
### Without a package manager
4653

4754
Add the following JavaScript snippet to the <head> of your website:
4855

4956
```html
50-
<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-abtesting.umd.min.js"></script>
57+
<script src="https://cdn.jsdelivr.net/npm/@algolia/client-abtesting@5.6.0/dist/builds/browser.umd.js"></script>
5158
```
5259

60+
### Usage
61+
5362
You can now import the Algolia API client in your project and play with it.
5463

5564
```js
@@ -58,7 +67,7 @@ import { abtestingClient } from '@algolia/client-abtesting';
5867
const client = abtestingClient('YOUR_APP_ID', 'YOUR_API_KEY');
5968
```
6069

61-
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
70+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/abtesting/)**.
6271

6372
## ❓ Troubleshooting
6473

‎packages/client-analytics/README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,33 @@
3232

3333
## 💡 Getting Started
3434

35-
To get started, you first need to install @algolia/client-analytics (or any other available API client package).
35+
> [!TIP]
36+
> 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.
3637
38+
To get started, you first need to install @algolia/client-analytics (or any other available API client package).
3739
All of our clients comes with type definition, and are available for both browser and node environments.
3840

41+
### With a package manager
42+
43+
3944
```bash
40-
yarn add @algolia/client-analytics
45+
yarn add @algolia/[email protected]
46+
# or
47+
npm install @algolia/[email protected]
4148
# or
42-
npm install @algolia/client-analytics
49+
pnpm add @algolia/client-analytics@5.6.0
4350
```
4451

45-
Without a package manager
52+
### Without a package manager
4653

4754
Add the following JavaScript snippet to the <head> of your website:
4855

4956
```html
50-
<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-analytics.umd.min.js"></script>
57+
<script src="https://cdn.jsdelivr.net/npm/@algolia/client-analytics@5.6.0/dist/builds/browser.umd.js"></script>
5158
```
5259

60+
### Usage
61+
5362
You can now import the Algolia API client in your project and play with it.
5463

5564
```js
@@ -58,7 +67,7 @@ import { analyticsClient } from '@algolia/client-analytics';
5867
const client = analyticsClient('YOUR_APP_ID', 'YOUR_API_KEY');
5968
```
6069

61-
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
70+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/analytics/)**.
6271

6372
## ❓ Troubleshooting
6473

‎packages/client-insights/README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,31 @@
3232

3333
## 💡 Getting Started
3434

35-
To get started, you first need to install @algolia/client-insights (or any other available API client package).
3635

36+
To get started, you first need to install @algolia/client-insights (or any other available API client package).
3737
All of our clients comes with type definition, and are available for both browser and node environments.
3838

39+
### With a package manager
40+
41+
3942
```bash
40-
yarn add @algolia/client-insights
43+
yarn add @algolia/[email protected]
44+
# or
45+
npm install @algolia/[email protected]
4146
# or
42-
npm install @algolia/client-insights
47+
pnpm add @algolia/client-insights@5.6.0
4348
```
4449

45-
Without a package manager
50+
### Without a package manager
4651

4752
Add the following JavaScript snippet to the <head> of your website:
4853

4954
```html
50-
<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-insights.umd.min.js"></script>
55+
<script src="https://cdn.jsdelivr.net/npm/@algolia/client-insights@5.6.0/dist/builds/browser.umd.js"></script>
5156
```
5257

58+
### Usage
59+
5360
You can now import the Algolia API client in your project and play with it.
5461

5562
```js
@@ -58,7 +65,7 @@ import { insightsClient } from '@algolia/client-insights';
5865
const client = insightsClient('YOUR_APP_ID', 'YOUR_API_KEY');
5966
```
6067

61-
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
68+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/insights/)**.
6269

6370
## ❓ Troubleshooting
6471

‎packages/client-personalization/README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,33 @@
3232

3333
## 💡 Getting Started
3434

35-
To get started, you first need to install @algolia/client-personalization (or any other available API client package).
35+
> [!TIP]
36+
> 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.
3637
38+
To get started, you first need to install @algolia/client-personalization (or any other available API client package).
3739
All of our clients comes with type definition, and are available for both browser and node environments.
3840

41+
### With a package manager
42+
43+
3944
```bash
40-
yarn add @algolia/client-personalization
45+
yarn add @algolia/[email protected]
46+
# or
47+
npm install @algolia/[email protected]
4148
# or
42-
npm install @algolia/client-personalization
49+
pnpm add @algolia/client-personalization@5.6.0
4350
```
4451

45-
Without a package manager
52+
### Without a package manager
4653

4754
Add the following JavaScript snippet to the <head> of your website:
4855

4956
```html
50-
<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-personalization.umd.min.js"></script>
57+
<script src="https://cdn.jsdelivr.net/npm/@algolia/client-personalization@5.6.0/dist/builds/browser.umd.js"></script>
5158
```
5259

60+
### Usage
61+
5362
You can now import the Algolia API client in your project and play with it.
5463

5564
```js
@@ -58,7 +67,7 @@ import { personalizationClient } from '@algolia/client-personalization';
5867
const client = personalizationClient('YOUR_APP_ID', 'YOUR_API_KEY');
5968
```
6069

61-
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
70+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/personalization/)**.
6271

6372
## ❓ Troubleshooting
6473

‎packages/client-query-suggestions/README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,31 @@
3232

3333
## 💡 Getting Started
3434

35-
To get started, you first need to install @algolia/client-query-suggestions (or any other available API client package).
3635

36+
To get started, you first need to install @algolia/client-query-suggestions (or any other available API client package).
3737
All of our clients comes with type definition, and are available for both browser and node environments.
3838

39+
### With a package manager
40+
41+
3942
```bash
40-
yarn add @algolia/client-query-suggestions
43+
yarn add @algolia/[email protected]
44+
# or
45+
npm install @algolia/[email protected]
4146
# or
42-
npm install @algolia/client-query-suggestions
47+
pnpm add @algolia/client-query-suggestions@5.6.0
4348
```
4449

45-
Without a package manager
50+
### Without a package manager
4651

4752
Add the following JavaScript snippet to the <head> of your website:
4853

4954
```html
50-
<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-query-suggestions.umd.min.js"></script>
55+
<script src="https://cdn.jsdelivr.net/npm/@algolia/client-query-suggestions@5.6.0/dist/builds/browser.umd.js"></script>
5156
```
5257

58+
### Usage
59+
5360
You can now import the Algolia API client in your project and play with it.
5461

5562
```js
@@ -58,7 +65,7 @@ import { querySuggestionsClient } from '@algolia/client-query-suggestions';
5865
const client = querySuggestionsClient('YOUR_APP_ID', 'YOUR_API_KEY');
5966
```
6067

61-
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
68+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/query-suggestions/)**.
6269

6370
## ❓ Troubleshooting
6471

‎packages/client-search/README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,33 @@
3232

3333
## 💡 Getting Started
3434

35-
To get started, you first need to install @algolia/client-search (or any other available API client package).
35+
> [!TIP]
36+
> 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.
3637
38+
To get started, you first need to install @algolia/client-search (or any other available API client package).
3739
All of our clients comes with type definition, and are available for both browser and node environments.
3840

41+
### With a package manager
42+
43+
3944
```bash
40-
yarn add @algolia/client-search
45+
yarn add @algolia/[email protected]
46+
# or
47+
npm install @algolia/[email protected]
4148
# or
42-
npm install @algolia/client-search
49+
pnpm add @algolia/client-search@5.6.0
4350
```
4451

45-
Without a package manager
52+
### Without a package manager
4653

4754
Add the following JavaScript snippet to the <head> of your website:
4855

4956
```html
50-
<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-search.umd.min.js"></script>
57+
<script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.6.0/dist/builds/browser.umd.js"></script>
5158
```
5259

60+
### Usage
61+
5362
You can now import the Algolia API client in your project and play with it.
5463

5564
```js
@@ -58,7 +67,7 @@ import { searchClient } from '@algolia/client-search';
5867
const client = searchClient('YOUR_APP_ID', 'YOUR_API_KEY');
5968
```
6069

61-
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
70+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/search/)**.
6271

6372
## ❓ Troubleshooting
6473

0 commit comments

Comments
 (0)