Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(clients): mention main branch instead of master #3566

Merged
merged 8 commits into from
Aug 20, 2024
Merged

fix(clients): mention main branch instead of master #3566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1eddaa2
fix(csharp): changelog location
shortcuts Aug 20, 2024
3bef51e
Merge branch 'main' into fix/csharp-changelog
shortcuts Aug 20, 2024
638a8bb
chore: golang readme
shortcuts Aug 20, 2024
e67cd65
chore: doc links and other readmes
shortcuts Aug 20, 2024
2dfe816
Merge branch 'main' into fix/csharp-changelog
shortcuts Aug 20, 2024
6cc987e
chore: kotlin
shortcuts Aug 20, 2024
ff1c730
chore: kotlin
shortcuts Aug 20, 2024
32ab8d1
chore: tired
shortcuts Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion clients/algoliasearch-client-csharp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ var response = await client.SearchAsync<Object>(
);
```

For full documentation, visit the **[Algolia CSharp API Client](https://www.algolia.com/doc/api-client/getting-started/install/csharp/)**.
For full documentation, visit the **[Algolia CSharp API Client](https://www.algolia.com/doc/libraries/csharp/)**.

## ❓ Troubleshooting

Expand Down
6 changes: 3 additions & 3 deletions clients/algoliasearch-client-go/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@
<a href="https://github.com/algolia/algoliasearch-client-go/tags"><img src="https://img.shields.io/github/tag/algolia/algoliasearch-client-go.svg?include_prereleases&sort=semver" alt="Github Releases"></img></a>
<a href="https://pkg.go.dev/github.com/algolia/algoliasearch-client-go/v4"><img src="https://pkg.go.dev/badge/github.com/algolia/algoliasearch-client-go/v4" alt="GoDoc"></img></a>
<a href="https://goreportcard.com/report/github.com/algolia/algoliasearch-client-go"><img src="https://goreportcard.com/badge/github.com/algolia/algoliasearch-client-go" alt="Go Report Card"></img></a>
<a href="https://github.com/algolia/algoliasearch-client-go/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></img></a>
<a href="https://github.com/algolia/algoliasearch-client-go/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></img></a>
<img src="https://img.shields.io/badge/Go-%3E=1.21-green.svg" alt="Supported version"></img></a>
</p>
</p>

<p align="center">
<a href="https://www.algolia.com/doc/api-client/getting-started/install/go/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/go/" target="_blank">Documentation</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
<a href="https://github.com/algolia/algoliasearch-client-go/issues" target="_blank">Report a bug</a> •
Expand Down Expand Up @@ -80,7 +80,7 @@ if err != nil {
print(response)
```

For full documentation, visit the **[Algolia Go API Client](https://www.algolia.com/doc/api-client/getting-started/install/go/)**.
For full documentation, visit the **[Algolia Go API Client](https://www.algolia.com/doc/libraries/go/)**.

## ❓ Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions clients/algoliasearch-client-java/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</p>

<p align="center">
<a href="https://www.algolia.com/doc/api-client/getting-started/install/java/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/java/" target="_blank">Documentation</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
<a href="https://github.com/algolia/algoliasearch-client-java/issues" target="_blank">Report a bug</a> •
Expand Down Expand Up @@ -69,7 +69,7 @@ client.search(
);
```

For full documentation, visit the **[Algolia Java API Client](https://www.algolia.com/doc/api-client/getting-started/install/java/)**.
For full documentation, visit the **[Algolia Java API Client](https://www.algolia.com/doc/libraries/java/)**.

## ❓ Troubleshooting

Expand Down
6 changes: 3 additions & 3 deletions clients/algoliasearch-client-javascript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</p>

<p align="center">
<a href="https://www.algolia.com/doc/api-client/getting-started/install/javascript/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/javascript/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
Expand Down Expand Up @@ -63,12 +63,12 @@ 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/api-client/getting-started/install/javascript/)**.
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.

## ❓ Troubleshooting

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)

## 📄 License

The Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE).
The Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE).
11 changes: 2 additions & 9 deletions clients/algoliasearch-client-kotlin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</p>

<p align="center">
<a href="https://www.algolia.com/doc/api-client/getting-started/install/kotlin/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/kotlin/" target="_blank">Documentation</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
<a href="https://github.com/algolia/algoliasearch-client-kotlin/issues" target="_blank">Report a bug</a> •
Expand Down Expand Up @@ -47,15 +47,8 @@ Install the Kotlin client by adding the following dependency to your `gradle.bui
```
Also, choose and add to your dependencies one of [Ktor http client engines](https://ktor.io/docs/http-client-engines.html).
Alternatively, you can use [algoliasearch-client-kotlin-bom](/client-bom).
For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/api-client/getting-started/install/kotlin/)**.

### Guides

- [Getting started](https://github.com/algolia/algoliasearch-client-kotlin/tree/master/docs/GettingStarted.md)
- [DSL](https://github.com/algolia/algoliasearch-client-kotlin/tree/master/docs/DSL.md)
- [Serialization](https://github.com/algolia/algoliasearch-client-kotlin/tree/master/docs/Serialization.md)
- [ExceptionHandling](https://github.com/algolia/algoliasearch-client-kotlin/tree/master/docs/ExceptionHandling.md)
- [Configure the HTTP client](https://github.com/algolia/algoliasearch-client-kotlin/tree/master/docs/HTTPClient.md)
For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/libraries/kotlin/)**.

## ❓ Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions clients/algoliasearch-client-php/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</p>

<p align="center">
<a href="https://www.algolia.com/doc/api-client/getting-started/install/php/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/php/" target="_blank">Documentation</a> •
<a href="https://github.com/algolia/scout-extended" target="_blank">Laravel</a> •
<a href="https://github.com/algolia/search-bundle" target="_blank">Symfony</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
Expand Down Expand Up @@ -73,7 +73,7 @@ $response = $client->search(
var_dump($response);
```

For full documentation, visit the **[Algolia PHP API Client](https://www.algolia.com/doc/api-client/getting-started/install/php/)**.
For full documentation, visit the **[Algolia PHP API Client](https://www.algolia.com/doc/libraries/php/)**.

## ❓ Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions clients/algoliasearch-client-python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</p>

<p align="center">
<a href="https://www.algolia.com/doc/api-client/getting-started/install/python/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/python/" target="_blank">Documentation</a> •
<a href="https://github.com/algolia/algoliasearch-django" target="_blank">Django</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
Expand Down Expand Up @@ -80,7 +80,7 @@ print(response)
print(response.to_json())
```

For full documentation, visit the **[Algolia Python API Client](https://www.algolia.com/doc/api-client/getting-started/install/python/)**.
For full documentation, visit the **[Algolia Python API Client](https://www.algolia.com/doc/libraries/python/)**.

## ❓ Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions clients/algoliasearch-client-ruby/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</p>

<p align="center">
<a href="https://www.algolia.com/doc/api-client/getting-started/install/ruby/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/ruby/" target="_blank">Documentation</a> •
<a href="https://github.com/algolia/algoliasearch-rails" target="_blank">Rails</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
Expand Down Expand Up @@ -47,7 +47,7 @@ Finally, you may begin searching a object using the `search` method:
objects = client.search_single_index('your_index_name', 'Foo')
```

For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/api-client/getting-started/install/ruby/)**.
For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/libraries/ruby/)**.

## ❓ Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions clients/algoliasearch-client-scala/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</p>

<p align="center">
<a href="https://www.algolia.com/doc/api-client/getting-started/install/scala/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/scala/" target="_blank">Documentation</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="https://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
<a href="https://github.com/algolia/algoliasearch-client-scala/issues" target="_blank">Report a bug</a> •
Expand Down Expand Up @@ -116,7 +116,7 @@ val response = client.search(
val value = Await.result(response, Duration(100, "sec"))
```

For full documentation, visit the **[Algolia Scala API Client](https://www.algolia.com/doc/api-client/getting-started/install/scala/)**.
For full documentation, visit the **[Algolia Scala API Client](https://www.algolia.com/doc/libraries/scala/)**.

## ❓ Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions clients/algoliasearch-client-swift/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@


<p align="center">
<a href="https://www.algolia.com/doc/api-client/getting-started/install/swift/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/swift/" target="_blank">Documentation</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
<a href="https://github.com/algolia/algoliasearch-client-swift/issues" target="_blank">Report a bug</a> •
Expand Down Expand Up @@ -133,7 +133,7 @@ let response: SearchResponses<Hit> = try await client
))]))
```

For full documentation, visit the **[Algolia Swift API Client](https://www.algolia.com/doc/api-client/getting-started/install/swift/)**.
For full documentation, visit the **[Algolia Swift API Client](https://www.algolia.com/doc/libraries/swift/)**.

## Notes

Expand Down
6 changes: 3 additions & 3 deletions templates/csharp/netcore_project.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@
<PackageId>Algolia.Search</PackageId>
<Company>Algolia</Company>
<PackageTags>Algolia;Search;SearchEngine;Service;Instant;Typo-Tolerance;Realtime;Analytics</PackageTags>
<PackageReleaseNotes>https://github.com/algolia/algoliasearch-client-csharp/blob/master/CHANGELOG.md</PackageReleaseNotes>
<PackageReleaseNotes>https://github.com/algolia/algoliasearch-client-csharp/blob/main/CHANGELOG.md</PackageReleaseNotes>
<PackageIconUrl>https://s.gravatar.com/avatar/ef38ca989ef6a4a6373435c257373b84?s=80</PackageIconUrl>
<PackageDescription>
Algolia is a powerful search-as-a-service solution, made easy to use with API clients, UI libraries, and pre-built integrations. Algolia API Client for the .NET framework lets you easily use the Algolia Search REST API from your .NET code.
</PackageDescription>
<PackageIcon>icon.png</PackageIcon>
<PackageProjectUrl>https://www.algolia.com/doc/api-client/getting-started/install/csharp/</PackageProjectUrl>
<PackageProjectUrl>https://www.algolia.com/doc/libraries/csharp/</PackageProjectUrl>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<RepositoryUrl>https://github.com/algolia/algoliasearch-client-csharp</RepositoryUrl>
<RepositoryType>git</RepositoryType>
Expand Down Expand Up @@ -58,4 +58,4 @@
</Content>
</ItemGroup>

{{> netcore_project.additions}}</Project>
{{> netcore_project.additions}}</Project>
4 changes: 2 additions & 2 deletions templates/javascript/clients/README.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</p>

<p align="center">
<a href="https://www.algolia.com/doc/api-client/getting-started/install/javascript/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/javascript/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
Expand Down Expand Up @@ -70,7 +70,7 @@ const client = {{apiName}}('YOUR_APP_ID', 'YOUR_API_KEY');
{{/isAlgoliasearchClient}}
```

For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/api-client/getting-started/install/javascript/)**.
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.

## ❓ Troubleshooting

Expand Down
14 changes: 3 additions & 11 deletions templates/kotlin/README.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<img alt="Algolia for Kotlin" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/kotlin.png" >
</a>

<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your Kotlin project</h4>
<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your Kotlin project</h4>

<p align="center">
<a href="https://search.maven.org/search?q=a:algoliasearch-client-kotlin"><img src="https://img.shields.io/maven-central/v/com.algolia/algoliasearch-client-kotlin?label=Download" alt="Latest version"></img></a>
Expand All @@ -12,7 +12,7 @@
</p>

<p align="center">
<a href="https://www.algolia.com/doc/api-client/getting-started/install/kotlin/" target="_blank">Documentation</a> •
<a href="https://www.algolia.com/doc/libraries/kotlin/" target="_blank">Documentation</a> •
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
<a href="https://github.com/algolia/algoliasearch-client-kotlin/issues" target="_blank">Report a bug</a> •
Expand Down Expand Up @@ -114,15 +114,7 @@ var response = client.search(
println(response)
```

For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/api-client/getting-started/install/kotlin/)**.

### Guides

- [Getting started](https://github.com/algolia/algoliasearch-client-kotlin/tree/master/docs/GettingStarted.md)
- [DSL](https://github.com/algolia/algoliasearch-client-kotlin/tree/master/docs/DSL.md)
- [Serialization](https://github.com/algolia/algoliasearch-client-kotlin/tree/master/docs/Serialization.md)
- [ExceptionHandling](https://github.com/algolia/algoliasearch-client-kotlin/tree/master/docs/ExceptionHandling.md)
- [Configure the HTTP client](https://github.com/algolia/algoliasearch-client-kotlin/tree/master/docs/HTTPClient.md)
For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/libraries/kotlin/)**.

## ❓ Troubleshooting

Expand Down
Loading