Skip to content

Commit 9e0cec7

Browse files
authored
fix(python): remove contact (#3161)
1 parent dfcda79 commit 9e0cec7

File tree

14 files changed

+93
-19
lines changed

14 files changed

+93
-19
lines changed

clients/algoliasearch-client-csharp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
1818
<a href="https://github.com/algolia/algoliasearch-client-csharp/issues" target="_blank">Report a bug</a> •
1919
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/csharp/" target="_blank">FAQ</a> •
20-
<a href="https://www.algolia.com/support" target="_blank">Support</a>
20+
<a href="https://alg.li/support" target="_blank">Support</a>
2121
</p>
2222

2323
## ✨ Features

clients/algoliasearch-client-dart/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
2323
<a href="https://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
2424
<a href="https://github.com/algolia/algoliasearch-client-dart/issues" target="_blank">Report a Bug</a> •
25-
<a href="https://www.algolia.com/support" target="_blank">Support</a>
25+
<a href="https://alg.li/support" target="_blank">Support</a>
2626
</p>
2727

2828
## 📚 Description

clients/algoliasearch-client-dart/packages/algoliasearch/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
2323
<a href="https://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
2424
<a href="https://github.com/algolia/algoliasearch-client-dart/issues" target="_blank">Report a Bug</a> •
25-
<a href="https://www.algolia.com/support" target="_blank">Support</a>
25+
<a href="https://alg.li/support" target="_blank">Support</a>
2626
</p>
2727

2828
## 📚 Description

clients/algoliasearch-client-go/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
2121
<a href="https://github.com/algolia/algoliasearch-client-go/issues" target="_blank">Report a bug</a> •
2222
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/go/" target="_blank">FAQ</a> •
23-
<a href="https://www.algolia.com/support" target="_blank">Support</a>
23+
<a href="https://alg.li/support" target="_blank">Support</a>
2424
</p>
2525

2626
# Pre-Release Notice

clients/algoliasearch-client-java/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
1818
<a href="https://github.com/algolia/algoliasearch-client-java/issues" target="_blank">Report a bug</a> •
1919
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/java/" target="_blank">FAQ</a> •
20-
<a href="https://www.algolia.com/support" target="_blank">Support</a>
20+
<a href="https://alg.li/support" target="_blank">Support</a>
2121
</p>
2222

2323
## ✨ Features

clients/algoliasearch-client-javascript/README.md

Lines changed: 79 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
....
2-
31
<p align="center">
42
<a href="https://www.algolia.com">
53
<img alt="Algolia for JavaScript" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/javascript.png" >
@@ -16,9 +14,85 @@
1614
</p>
1715

1816
<p align="center">
19-
<a href="https://api-clients-automation.netlify.app/docs/clients/introduction" target="_blank">Documentation</a>
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>
2024
</p>
2125

22-
# Contributing to this repository
26+
**Migration note from v4.x to v5.x**
27+
28+
> In July 2024, we released the v5 version of our JavaScript client. If you are using version 4.x of the client, read the [migration guide to version 5.x](https://api-clients-automation.netlify.app/docs/clients/migration-guides/). Version 4.x will **no longer** be under active development.
29+
30+
## ✨ Features
31+
32+
- Thin & **minimal low-level HTTP client** to interact with Algolia's API
33+
- Works both on the **browser** and **node.js**
34+
- **UMD and ESM compatible**, you can use it with any module loader
35+
- Built with TypeScript
36+
37+
## 💡 Getting Started
38+
39+
First, install Algolia JavaScript API Client via your favorite package manager:
40+
41+
```bash
42+
yarn add algoliasearch@beta
43+
# or
44+
npm install algoliasearch@beta
45+
```
46+
47+
Or Without a package manager:
48+
49+
Add the following JavaScript snippet to the `<head>` of your website:
50+
51+
```html
52+
<script src="https://cdn.jsdelivr.net/npm/algoliasearch@beta/dist/algoliasearch.umd.min.js"></script>
53+
```
54+
55+
Then, create objects on your index:
56+
57+
```js
58+
import { algoliasearch } from 'algoliasearch';
59+
60+
const client = algoliasearch('YourApplicationID', 'YourAdminAPIKey');
61+
62+
// Add a new record to your Algolia index
63+
const saveResponse = await client.saveObject({
64+
indexName: '<YOUR_INDEX_NAME>',
65+
body: { objectID: 'id', test: 'val' },
66+
});
67+
68+
// use typed response
69+
console.log(saveResponse);
70+
71+
// Poll the task status to know when it has been indexed
72+
await client.waitForTask({ indexName: '<YOUR_INDEX_NAME>', taskID: saveResponse.taskID });
73+
74+
// Fetch search results, with typo tolerance
75+
const searchResponse = await client.search({
76+
requests: [
77+
{
78+
indexName: '<YOUR_INDEX_NAME>',
79+
query: '<YOUR_QUERY>',
80+
hitsPerPage: 50,
81+
},
82+
],
83+
});
84+
85+
// use typed response
86+
console.log(searchResponse);
87+
```
88+
89+
For the full documentation, visit the **[online documentation](https://api-clients-automation.netlify.app/docs/clients/usage)**.
90+
91+
## ❓ Troubleshooting
92+
93+
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.
94+
95+
## 📄 License
96+
97+
Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).
2398

24-
The Algolia API clients are automatically generated, you can find everything here https://github.com/algolia/api-clients-automation

clients/algoliasearch-client-kotlin/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
1818
<a href="https://github.com/algolia/algoliasearch-client-kotlin/issues" target="_blank">Report a bug</a> •
1919
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/kotlin/" target="_blank">FAQ</a> •
20-
<a href="https://www.algolia.com/support" target="_blank">Support</a>
20+
<a href="https://alg.li/support" target="_blank">Support</a>
2121
</p>
2222

2323
## ✨ Features

clients/algoliasearch-client-python/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
2020
<a href="https://github.com/algolia/algoliasearch-client-python/issues" target="_blank">Report a bug</a> •
2121
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/python/" target="_blank">FAQ</a> •
22-
<a href="https://www.algolia.com/support" target="_blank">Support</a>
22+
<a href="https://alg.li/support" target="_blank">Support</a>
2323
</p>
2424

2525
## ✨ Features

clients/algoliasearch-client-ruby/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
2020
<a href="https://github.com/algolia/algoliasearch-client-ruby/issues" target="_blank">Report a bug</a> •
2121
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/" target="_blank">FAQ</a> •
22-
<a href="https://www.algolia.com/support" target="_blank">Support</a>
22+
<a href="https://alg.li/support" target="_blank">Support</a>
2323
</p>
2424

2525
## ✨ Features

clients/algoliasearch-client-scala/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a href="https://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
1818
<a href="https://github.com/algolia/algoliasearch-client-scala/issues" target="_blank">Report a bug</a> •
1919
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/scala/" target="_blank">FAQ</a> •
20-
<a href="https://www.algolia.com/support" target="_blank">Support</a>
20+
<a href="https://alg.li/support" target="_blank">Support</a>
2121
</p>
2222

2323
## ✨ Features

clients/algoliasearch-client-swift/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
3535
<a href="https://github.com/algolia/algoliasearch-client-swift/issues" target="_blank">Report a bug</a> •
3636
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/swift/" target="_blank">FAQ</a> •
37-
<a href="https://www.algolia.com/support" target="_blank">Support</a>
37+
<a href="https://alg.li/support" target="_blank">Support</a>
3838
</p>
3939

4040
## ✨ Features

templates/kotlin/README.mustache

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
1818
<a href="https://github.com/algolia/algoliasearch-client-kotlin/issues" target="_blank">Report a bug</a> •
1919
<a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/kotlin/" target="_blank">FAQ</a> •
20-
<a href="https://www.algolia.com/support" target="_blank">Support</a>
20+
<a href="https://alg.li/support" target="_blank">Support</a>
2121
</p>
2222

2323
## ✨ Features
@@ -67,4 +67,4 @@ If you want to contribute to this project without installing all its dependencie
6767

6868
## 📄 License
6969

70-
Algolia Kotlin API Client is an open-sourced software licensed under the [MIT license](LICENSE).
70+
Algolia Kotlin API Client is an open-sourced software licensed under the [MIT license](LICENSE).

templates/python/pyproject.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name = "algoliasearch"
33
version = "{{{packageVersion}}}"
44
description = "A fully-featured and blazing-fast Python API client to interact with Algolia."
5-
authors = ["Algolia Team <https://alg.li/support>"]
5+
authors = ["Algolia Team"]
66
license = "MIT"
77
readme = "README.md"
88
homepage = "https://www.algolia.com"

tests/output/python/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name = "tests"
33
version = "0.0.1"
44
description = "common test suite for the Python API client"
5-
authors = ["Algolia Team <https://alg.li/support>"]
5+
authors = ["Algolia Team"]
66
license = "MIT"
77
homepage = "https://www.algolia.com"
88
repository = "https://github.com/algolia/api-clients-automation"

0 commit comments

Comments
 (0)