Skip to content

Commit 9c79320

Browse files
algolia-botshortcuts
algolia-bot
and
shortcuts
committed
Merge branch 'main' into chore/beta-mentions-and-main-branch (generated)
Co-authored-by: Clément Vannicatte <[email protected]>
1 parent 2106ac7 commit 9c79320

File tree

13 files changed

+771
-2
lines changed

13 files changed

+771
-2
lines changed

‎clients/algoliasearch-client-javascript/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,11 @@ You can now import the Algolia API client in your project and play with it.
5555
```js
5656
import { algoliasearch } from 'algoliasearch';
5757

58+
const client = algoliasearch('YOUR_APP_ID', 'YOUR_API_KEY');
59+
60+
// or with the lite client
61+
import { liteClient } from 'algoliasearch/lite';
62+
5863
const client = liteClient('YOUR_APP_ID', 'YOUR_API_KEY');
5964
```
6065

‎clients/algoliasearch-client-javascript/packages/algoliasearch/README.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<p align="center">
2+
<a href="https://www.algolia.com">
3+
<img alt="Algolia for JavaScript" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/javascript.png" >
4+
</a>
5+
6+
<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your JavaScript project</h4>
7+
8+
<p align="center">
9+
<a href="https://npmjs.org/package/algoliasearch"><img src="https://img.shields.io/npm/v/algoliasearch.svg?style=flat-square" alt="NPM version"></img></a>
10+
<a href="http://npm-stat.com/charts.html?package=algoliasearch"><img src="https://img.shields.io/npm/dm/algoliasearch.svg?style=flat-square" alt="NPM downloads"></a>
11+
<a href="https://www.jsdelivr.com/package/npm/algoliasearch"><img src="https://data.jsdelivr.com/v1/package/npm/algoliasearch/badge" alt="jsDelivr Downloads"></img></a>
12+
<a href="LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
13+
</p>
14+
</p>
15+
16+
<p align="center">
17+
<a href="https://www.algolia.com/doc/api-client/getting-started/install/javascript/" target="_blank">Documentation</a> •
18+
<a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</a> •
19+
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
20+
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
21+
<a href="https://github.com/algolia/algoliasearch-client-javascript/issues" target="_blank">Report a bug</a> •
22+
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/javascript/" target="_blank">FAQ</a> •
23+
<a href="https://alg.li/support" target="_blank">Support</a>
24+
</p>
25+
26+
## ✨ Features
27+
28+
- Thin & **minimal low-level HTTP client** to interact with Algolia's API
29+
- Works both on the **browser** and **node.js**
30+
- **UMD and ESM compatible**, you can use it with any module loader
31+
- Built with TypeScript
32+
33+
## 💡 Getting Started
34+
35+
To get started, you first need to install algoliasearch (or any other available API client package).
36+
37+
All of our clients comes with type definition, and are available for both browser and node environments.
38+
39+
```bash
40+
yarn add algoliasearch
41+
# or
42+
npm install algoliasearch
43+
```
44+
45+
Without a package manager
46+
47+
Add the following JavaScript snippet to the <head> of your website:
48+
49+
```html
50+
<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/algoliasearch.umd.min.js"></script>
51+
```
52+
53+
You can now import the Algolia API client in your project and play with it.
54+
55+
```js
56+
import { algoliasearch } from 'algoliasearch';
57+
58+
const client = algoliasearch('YOUR_APP_ID', 'YOUR_API_KEY');
59+
60+
// or with the lite client
61+
import { liteClient } from 'algoliasearch/lite';
62+
63+
const client = liteClient('YOUR_APP_ID', 'YOUR_API_KEY');
64+
```
65+
66+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/api-client/getting-started/install/javascript/)**.
67+
68+
## ❓ Troubleshooting
69+
70+
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/javascript/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
71+
72+
## 📄 License
73+
74+
The Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE).

‎clients/algoliasearch-client-javascript/packages/client-abtesting/README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<p align="center">
2+
<a href="https://www.algolia.com">
3+
<img alt="Algolia for JavaScript" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/javascript.png" >
4+
</a>
5+
6+
<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your JavaScript project</h4>
7+
8+
<p align="center">
9+
<a href="https://npmjs.org/package/@algolia/client-abtesting"><img src="https://img.shields.io/npm/v/@algolia/client-abtesting.svg?style=flat-square" alt="NPM version"></img></a>
10+
<a href="http://npm-stat.com/charts.html?package=@algolia/client-abtesting"><img src="https://img.shields.io/npm/dm/@algolia/client-abtesting.svg?style=flat-square" alt="NPM downloads"></a>
11+
<a href="https://www.jsdelivr.com/package/npm/@algolia/client-abtesting"><img src="https://data.jsdelivr.com/v1/package/npm/@algolia/client-abtesting/badge" alt="jsDelivr Downloads"></img></a>
12+
<a href="LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
13+
</p>
14+
</p>
15+
16+
<p align="center">
17+
<a href="https://www.algolia.com/doc/api-client/getting-started/install/javascript/" target="_blank">Documentation</a> •
18+
<a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</a> •
19+
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
20+
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
21+
<a href="https://github.com/algolia/algoliasearch-client-javascript/issues" target="_blank">Report a bug</a> •
22+
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/javascript/" target="_blank">FAQ</a> •
23+
<a href="https://alg.li/support" target="_blank">Support</a>
24+
</p>
25+
26+
## ✨ Features
27+
28+
- Thin & **minimal low-level HTTP client** to interact with Algolia's API
29+
- Works both on the **browser** and **node.js**
30+
- **UMD and ESM compatible**, you can use it with any module loader
31+
- Built with TypeScript
32+
33+
## 💡 Getting Started
34+
35+
To get started, you first need to install @algolia/client-abtesting (or any other available API client package).
36+
37+
All of our clients comes with type definition, and are available for both browser and node environments.
38+
39+
```bash
40+
yarn add @algolia/client-abtesting
41+
# or
42+
npm install @algolia/client-abtesting
43+
```
44+
45+
Without a package manager
46+
47+
Add the following JavaScript snippet to the <head> of your website:
48+
49+
```html
50+
<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-abtesting.umd.min.js"></script>
51+
```
52+
53+
You can now import the Algolia API client in your project and play with it.
54+
55+
```js
56+
import { abtestingClient } from '@algolia/client-abtesting';
57+
58+
const client = abtestingClient('YOUR_APP_ID', 'YOUR_API_KEY');
59+
```
60+
61+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/api-client/getting-started/install/javascript/)**.
62+
63+
## ❓ Troubleshooting
64+
65+
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/javascript/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
66+
67+
## 📄 License
68+
69+
The Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE).

‎clients/algoliasearch-client-javascript/packages/client-analytics/README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<p align="center">
2+
<a href="https://www.algolia.com">
3+
<img alt="Algolia for JavaScript" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/javascript.png" >
4+
</a>
5+
6+
<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your JavaScript project</h4>
7+
8+
<p align="center">
9+
<a href="https://npmjs.org/package/@algolia/client-analytics"><img src="https://img.shields.io/npm/v/@algolia/client-analytics.svg?style=flat-square" alt="NPM version"></img></a>
10+
<a href="http://npm-stat.com/charts.html?package=@algolia/client-analytics"><img src="https://img.shields.io/npm/dm/@algolia/client-analytics.svg?style=flat-square" alt="NPM downloads"></a>
11+
<a href="https://www.jsdelivr.com/package/npm/@algolia/client-analytics"><img src="https://data.jsdelivr.com/v1/package/npm/@algolia/client-analytics/badge" alt="jsDelivr Downloads"></img></a>
12+
<a href="LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
13+
</p>
14+
</p>
15+
16+
<p align="center">
17+
<a href="https://www.algolia.com/doc/api-client/getting-started/install/javascript/" target="_blank">Documentation</a> •
18+
<a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</a> •
19+
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
20+
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
21+
<a href="https://github.com/algolia/algoliasearch-client-javascript/issues" target="_blank">Report a bug</a> •
22+
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/javascript/" target="_blank">FAQ</a> •
23+
<a href="https://alg.li/support" target="_blank">Support</a>
24+
</p>
25+
26+
## ✨ Features
27+
28+
- Thin & **minimal low-level HTTP client** to interact with Algolia's API
29+
- Works both on the **browser** and **node.js**
30+
- **UMD and ESM compatible**, you can use it with any module loader
31+
- Built with TypeScript
32+
33+
## 💡 Getting Started
34+
35+
To get started, you first need to install @algolia/client-analytics (or any other available API client package).
36+
37+
All of our clients comes with type definition, and are available for both browser and node environments.
38+
39+
```bash
40+
yarn add @algolia/client-analytics
41+
# or
42+
npm install @algolia/client-analytics
43+
```
44+
45+
Without a package manager
46+
47+
Add the following JavaScript snippet to the <head> of your website:
48+
49+
```html
50+
<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-analytics.umd.min.js"></script>
51+
```
52+
53+
You can now import the Algolia API client in your project and play with it.
54+
55+
```js
56+
import { analyticsClient } from '@algolia/client-analytics';
57+
58+
const client = analyticsClient('YOUR_APP_ID', 'YOUR_API_KEY');
59+
```
60+
61+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/api-client/getting-started/install/javascript/)**.
62+
63+
## ❓ Troubleshooting
64+
65+
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/javascript/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
66+
67+
## 📄 License
68+
69+
The Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE).

‎clients/algoliasearch-client-javascript/packages/client-insights/README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<p align="center">
2+
<a href="https://www.algolia.com">
3+
<img alt="Algolia for JavaScript" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/javascript.png" >
4+
</a>
5+
6+
<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your JavaScript project</h4>
7+
8+
<p align="center">
9+
<a href="https://npmjs.org/package/@algolia/client-insights"><img src="https://img.shields.io/npm/v/@algolia/client-insights.svg?style=flat-square" alt="NPM version"></img></a>
10+
<a href="http://npm-stat.com/charts.html?package=@algolia/client-insights"><img src="https://img.shields.io/npm/dm/@algolia/client-insights.svg?style=flat-square" alt="NPM downloads"></a>
11+
<a href="https://www.jsdelivr.com/package/npm/@algolia/client-insights"><img src="https://data.jsdelivr.com/v1/package/npm/@algolia/client-insights/badge" alt="jsDelivr Downloads"></img></a>
12+
<a href="LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
13+
</p>
14+
</p>
15+
16+
<p align="center">
17+
<a href="https://www.algolia.com/doc/api-client/getting-started/install/javascript/" target="_blank">Documentation</a> •
18+
<a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</a> •
19+
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
20+
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
21+
<a href="https://github.com/algolia/algoliasearch-client-javascript/issues" target="_blank">Report a bug</a> •
22+
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/javascript/" target="_blank">FAQ</a> •
23+
<a href="https://alg.li/support" target="_blank">Support</a>
24+
</p>
25+
26+
## ✨ Features
27+
28+
- Thin & **minimal low-level HTTP client** to interact with Algolia's API
29+
- Works both on the **browser** and **node.js**
30+
- **UMD and ESM compatible**, you can use it with any module loader
31+
- Built with TypeScript
32+
33+
## 💡 Getting Started
34+
35+
To get started, you first need to install @algolia/client-insights (or any other available API client package).
36+
37+
All of our clients comes with type definition, and are available for both browser and node environments.
38+
39+
```bash
40+
yarn add @algolia/client-insights
41+
# or
42+
npm install @algolia/client-insights
43+
```
44+
45+
Without a package manager
46+
47+
Add the following JavaScript snippet to the <head> of your website:
48+
49+
```html
50+
<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-insights.umd.min.js"></script>
51+
```
52+
53+
You can now import the Algolia API client in your project and play with it.
54+
55+
```js
56+
import { insightsClient } from '@algolia/client-insights';
57+
58+
const client = insightsClient('YOUR_APP_ID', 'YOUR_API_KEY');
59+
```
60+
61+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/api-client/getting-started/install/javascript/)**.
62+
63+
## ❓ Troubleshooting
64+
65+
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/javascript/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
66+
67+
## 📄 License
68+
69+
The Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE).

‎clients/algoliasearch-client-javascript/packages/client-personalization/README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<p align="center">
2+
<a href="https://www.algolia.com">
3+
<img alt="Algolia for JavaScript" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/javascript.png" >
4+
</a>
5+
6+
<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your JavaScript project</h4>
7+
8+
<p align="center">
9+
<a href="https://npmjs.org/package/@algolia/client-personalization"><img src="https://img.shields.io/npm/v/@algolia/client-personalization.svg?style=flat-square" alt="NPM version"></img></a>
10+
<a href="http://npm-stat.com/charts.html?package=@algolia/client-personalization"><img src="https://img.shields.io/npm/dm/@algolia/client-personalization.svg?style=flat-square" alt="NPM downloads"></a>
11+
<a href="https://www.jsdelivr.com/package/npm/@algolia/client-personalization"><img src="https://data.jsdelivr.com/v1/package/npm/@algolia/client-personalization/badge" alt="jsDelivr Downloads"></img></a>
12+
<a href="LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
13+
</p>
14+
</p>
15+
16+
<p align="center">
17+
<a href="https://www.algolia.com/doc/api-client/getting-started/install/javascript/" target="_blank">Documentation</a> •
18+
<a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</a> •
19+
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
20+
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
21+
<a href="https://github.com/algolia/algoliasearch-client-javascript/issues" target="_blank">Report a bug</a> •
22+
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/javascript/" target="_blank">FAQ</a> •
23+
<a href="https://alg.li/support" target="_blank">Support</a>
24+
</p>
25+
26+
## ✨ Features
27+
28+
- Thin & **minimal low-level HTTP client** to interact with Algolia's API
29+
- Works both on the **browser** and **node.js**
30+
- **UMD and ESM compatible**, you can use it with any module loader
31+
- Built with TypeScript
32+
33+
## 💡 Getting Started
34+
35+
To get started, you first need to install @algolia/client-personalization (or any other available API client package).
36+
37+
All of our clients comes with type definition, and are available for both browser and node environments.
38+
39+
```bash
40+
yarn add @algolia/client-personalization
41+
# or
42+
npm install @algolia/client-personalization
43+
```
44+
45+
Without a package manager
46+
47+
Add the following JavaScript snippet to the <head> of your website:
48+
49+
```html
50+
<script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/client-personalization.umd.min.js"></script>
51+
```
52+
53+
You can now import the Algolia API client in your project and play with it.
54+
55+
```js
56+
import { personalizationClient } from '@algolia/client-personalization';
57+
58+
const client = personalizationClient('YOUR_APP_ID', 'YOUR_API_KEY');
59+
```
60+
61+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/api-client/getting-started/install/javascript/)**.
62+
63+
## ❓ Troubleshooting
64+
65+
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/javascript/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
66+
67+
## 📄 License
68+
69+
The Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE).

0 commit comments

Comments
 (0)