Merge branch 'master' of https://github.com/algolia/algoliasearch-client-multiplatform

Author: q-litzler

README.md

@@ -1,12 +1,37 @@
-# AlgoliaSearch Client Kotlin
-
-[ ![Download](https://api.bintray.com/packages/algolia/maven/algoliasearch-client-kotlin/images/download.svg) ](https://bintray.com/algolia/maven/algoliasearch-client-kotlin/_latestVersion)
-
-## Compatibility
-
-The Kotlin client is compatible with Kotlin `1.3.30` and higher.
+<p align="center">
+  <a href="https://www.algolia.com">
+    <img alt="Algolia for Kotlin" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/readme-banner.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>
+
+  <p align="center">
+    <a href="https://bintray.com/algolia/maven/algoliasearch-client-kotlin/_latestVersion"><img src="https://api.bintray.com/packages/algolia/maven/algoliasearch-client-kotlin/images/download.svg" alt="Latest version"></img></a>
+    <a href="https://packagist.org/packages/algolia/scout-extended"><img src="https://poser.pugx.org/algolia/scout-extended/license.svg" alt="License"></a>
+  </p>
+</p>
+
+<p align="center">
+  <a href="https://www.algolia.com/doc/api-client/getting-started/install/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>  •
+  <a href="https://www.algolia.com/support" target="_blank">Support</a>
+</p>
+
+## ✨ Features
+
+- The Kotlin client is compatible with Kotlin `1.3.30` and higher.
+- It is compatible with Kotlin project on the JVM, such as backend and Android applications.
+- It relies on the open source Kotlin libraries for seamless integration into Kotlin projects:
+  - [Kotlin multiplatform](https://kotlinlang.org/docs/reference/multiplatform.html).
+  - [Kotlinx serialization](https://github.com/Kotlin/kotlinx.serialization) for json parsing.
+  - [Kotlinx coroutines](https://github.com/Kotlin/kotlinx.coroutines) for asynchronous operations.
+  - [Ktor](https://github.com/ktorio/ktor) HTTP client.
+- The Kotlin client integrates the actual Algolia documentation in each source file: Request parameters, response fields, methods and concepts; all are documented and link to the corresponding url of the Algolia doc website.
+- The client is thread-safe. You can use `SearchClient`, `AnalyticsClient`, and `InsightsClient` in a multithreaded environment.
 
-## Installation
+## 💡 Getting Started
 
 Install the Kotlin client by adding the following dependency to your `gradle.build` file:
 
@@ -26,25 +51,9 @@ Install the Kotlin client by adding the following dependency to your `gradle.bui
   }
   ```
 
-### Supported platforms
-
-This client is compatible with Kotlin and Android projects.
+For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/api-client/getting-started/install/kotlin/)**.
 
-## Stack
-
-This client provides a Kotlin implementation for using AlgoliaSearch.
-This client is built using the official Kotlin stack:
-  - [Kotlin multiplatform](https://kotlinlang.org/docs/reference/multiplatform.html).
-  - [Kotlinx serialization](https://github.com/Kotlin/kotlinx.serialization) for json parsing.
-  - [Kotlinx coroutines](https://github.com/Kotlin/kotlinx.coroutines) for asynchronous operations.
-  - [Ktor](https://github.com/ktorio/ktor) HTTP client.
-  
-## Integrated documentation
-
-The Kotlin client integrates the actual Algolia documentation in each source file: Request parameters, response fields, methods and concepts; all are documented and link to the corresponding url of the Algolia doc website. 
-
-
-## Coroutines
+### Coroutines
 
 All methods performing HTTP calls in the Kotlin client are [suspending functions](https://kotlinlang.org/docs/reference/coroutines/composing-suspending-functions.html#composing-suspending-functions). 
 This means these functions can only be called from a coroutine.
@@ -71,7 +80,7 @@ The Kotlin client doesn't execute HTTP calls on any particular thread, it is up
 Learn more about [coroutines](https://kotlinlang.org/docs/reference/coroutines/coroutines-guide.html).
 
 
-## Waiting for operations
+### Waiting for operations
 
 Waiting for an asynchronous server task is made available via a [function literal with receiver](https://kotlinlang.org/docs/reference/lambdas.html#function-literals-with-receiver).
 
@@ -88,11 +97,7 @@ client.run {
 
 The `wait` functions are suspending, and should only be called from a coroutine.
 
-## Multithreading
-
-The client is designed to be thread-safe. You can use `SearchClient`, `AnalyticsClient`, and `InsightsClient` in a multithreaded environment.
-
-## Type safety
+### Type safety
 
 Response and parameters objects are typed to provide extensive compile time safety coverage.
 
@@ -127,157 +132,14 @@ query.sortFacetsBy = SortFacetsBy.Count
 // query.sortFacetsBy = SortFacetsBy.Other("unforeseen value")
 ```
 
-
-## Guides
+### 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)
 
-## List of available methods
-
-
-
-
-
-### Personalization
-
-- [Add strategy](https://algolia.com/doc/api-reference/api-methods/add-strategy/?language=kotlin)
-- [Get strategy](https://algolia.com/doc/api-reference/api-methods/get-strategy/?language=kotlin)
-
-
-
-
-### Search
-
-- [Search index](https://algolia.com/doc/api-reference/api-methods/search/?language=kotlin)
-- [Search for facet values](https://algolia.com/doc/api-reference/api-methods/search-for-facet-values/?language=kotlin)
-- [Search multiple indices](https://algolia.com/doc/api-reference/api-methods/multiple-queries/?language=kotlin)
-- [Browse index](https://algolia.com/doc/api-reference/api-methods/browse/?language=kotlin)
-
-
-
-
-### Indexing
-
-- [Add objects](https://algolia.com/doc/api-reference/api-methods/add-objects/?language=kotlin)
-- [Save objects](https://algolia.com/doc/api-reference/api-methods/save-objects/?language=kotlin)
-- [Partial update objects](https://algolia.com/doc/api-reference/api-methods/partial-update-objects/?language=kotlin)
-- [Delete objects](https://algolia.com/doc/api-reference/api-methods/delete-objects/?language=kotlin)
-- [Replace all objects](https://algolia.com/doc/api-reference/api-methods/replace-all-objects/?language=kotlin)
-- [Delete by](https://algolia.com/doc/api-reference/api-methods/delete-by/?language=kotlin)
-- [Clear objects](https://algolia.com/doc/api-reference/api-methods/clear-objects/?language=kotlin)
-- [Get objects](https://algolia.com/doc/api-reference/api-methods/get-objects/?language=kotlin)
-- [Custom batch](https://algolia.com/doc/api-reference/api-methods/batch/?language=kotlin)
-
-
-
-
-### Settings
-
-- [Get settings](https://algolia.com/doc/api-reference/api-methods/get-settings/?language=kotlin)
-- [Set settings](https://algolia.com/doc/api-reference/api-methods/set-settings/?language=kotlin)
-- [Copy settings](https://algolia.com/doc/api-reference/api-methods/copy-settings/?language=kotlin)
-
-
-
-
-### Manage indices
-
-- [List indices](https://algolia.com/doc/api-reference/api-methods/list-indices/?language=kotlin)
-- [Delete index](https://algolia.com/doc/api-reference/api-methods/delete-index/?language=kotlin)
-- [Copy index](https://algolia.com/doc/api-reference/api-methods/copy-index/?language=kotlin)
-- [Move index](https://algolia.com/doc/api-reference/api-methods/move-index/?language=kotlin)
-
-
-
-
-### API keys
-
-- [Create secured API Key](https://algolia.com/doc/api-reference/api-methods/generate-secured-api-key/?language=kotlin)
-- [Add API Key](https://algolia.com/doc/api-reference/api-methods/add-api-key/?language=kotlin)
-- [Update API Key](https://algolia.com/doc/api-reference/api-methods/update-api-key/?language=kotlin)
-- [Delete API Key](https://algolia.com/doc/api-reference/api-methods/delete-api-key/?language=kotlin)
-- [Restore API Key](https://algolia.com/doc/api-reference/api-methods/restore-api-key/?language=kotlin)
-- [Get API Key permissions](https://algolia.com/doc/api-reference/api-methods/get-api-key/?language=kotlin)
-- [List API Keys](https://algolia.com/doc/api-reference/api-methods/list-api-keys/?language=kotlin)
-
-
-
-
-### Synonyms
-
-- [Save synonym](https://algolia.com/doc/api-reference/api-methods/save-synonym/?language=kotlin)
-- [Batch synonyms](https://algolia.com/doc/api-reference/api-methods/batch-synonyms/?language=kotlin)
-- [Delete synonym](https://algolia.com/doc/api-reference/api-methods/delete-synonym/?language=kotlin)
-- [Clear all synonyms](https://algolia.com/doc/api-reference/api-methods/clear-synonyms/?language=kotlin)
-- [Get synonym](https://algolia.com/doc/api-reference/api-methods/get-synonym/?language=kotlin)
-- [Search synonyms](https://algolia.com/doc/api-reference/api-methods/search-synonyms/?language=kotlin)
-- [Replace all synonyms](https://algolia.com/doc/api-reference/api-methods/replace-all-synonyms/?language=kotlin)
-- [Copy synonyms](https://algolia.com/doc/api-reference/api-methods/copy-synonyms/?language=kotlin)
-- [Export Synonyms](https://algolia.com/doc/api-reference/api-methods/export-synonyms/?language=kotlin)
-
-
-
-
-### Query rules
-
-- [Save rule](https://algolia.com/doc/api-reference/api-methods/save-rule/?language=kotlin)
-- [Batch rules](https://algolia.com/doc/api-reference/api-methods/batch-rules/?language=kotlin)
-- [Get rule](https://algolia.com/doc/api-reference/api-methods/get-rule/?language=kotlin)
-- [Delete rule](https://algolia.com/doc/api-reference/api-methods/delete-rule/?language=kotlin)
-- [Clear rules](https://algolia.com/doc/api-reference/api-methods/clear-rules/?language=kotlin)
-- [Search rules](https://algolia.com/doc/api-reference/api-methods/search-rules/?language=kotlin)
-- [Replace all rules](https://algolia.com/doc/api-reference/api-methods/replace-all-rules/?language=kotlin)
-- [Copy rules](https://algolia.com/doc/api-reference/api-methods/copy-rules/?language=kotlin)
-- [Export rules](https://algolia.com/doc/api-reference/api-methods/export-rules/?language=kotlin)
-
-
-
-
-### A/B Test
-
-- [Add A/B test](https://algolia.com/doc/api-reference/api-methods/add-ab-test/?language=kotlin)
-- [Get A/B test](https://algolia.com/doc/api-reference/api-methods/get-ab-test/?language=kotlin)
-- [List A/B tests](https://algolia.com/doc/api-reference/api-methods/list-ab-tests/?language=kotlin)
-- [Stop A/B test](https://algolia.com/doc/api-reference/api-methods/stop-ab-test/?language=kotlin)
-- [Delete A/B test](https://algolia.com/doc/api-reference/api-methods/delete-ab-test/?language=kotlin)
-
-
-
-
-### Insights
-
-- [Clicked Object IDs After Search](https://algolia.com/doc/api-reference/api-methods/clicked-object-ids-after-search/?language=kotlin)
-- [Clicked Object IDs](https://algolia.com/doc/api-reference/api-methods/clicked-object-ids/?language=kotlin)
-- [Clicked Filters](https://algolia.com/doc/api-reference/api-methods/clicked-filters/?language=kotlin)
-- [Converted Objects IDs After Search](https://algolia.com/doc/api-reference/api-methods/converted-object-ids-after-search/?language=kotlin)
-- [Converted Object IDs](https://algolia.com/doc/api-reference/api-methods/converted-object-ids/?language=kotlin)
-- [Converted Filters](https://algolia.com/doc/api-reference/api-methods/converted-filters/?language=kotlin)
-- [Viewed Object IDs](https://algolia.com/doc/api-reference/api-methods/viewed-object-ids/?language=kotlin)
-- [Viewed Filters](https://algolia.com/doc/api-reference/api-methods/viewed-filters/?language=kotlin)
-
-
-
-
-### MultiClusters
-
-- [Assign or Move userID](https://algolia.com/doc/api-reference/api-methods/assign-user-id/?language=kotlin)
-- [Get top userID](https://algolia.com/doc/api-reference/api-methods/get-top-user-id/?language=kotlin)
-- [Get userID](https://algolia.com/doc/api-reference/api-methods/get-user-id/?language=kotlin)
-- [List clusters](https://algolia.com/doc/api-reference/api-methods/list-clusters/?language=kotlin)
-- [List userIDs](https://algolia.com/doc/api-reference/api-methods/list-user-id/?language=kotlin)
-- [Remove userID](https://algolia.com/doc/api-reference/api-methods/remove-user-id/?language=kotlin)
-- [Search userID](https://algolia.com/doc/api-reference/api-methods/search-user-id/?language=kotlin)
-
-
-
-
-### Advanced
+## 📄 License
 
-- [Get logs](https://algolia.com/doc/api-reference/api-methods/get-logs/?language=kotlin)
-- [Configuring timeouts](https://algolia.com/doc/api-reference/api-methods/configuring-timeouts/?language=kotlin)
-- [Set extra header](https://algolia.com/doc/api-reference/api-methods/set-extra-header/?language=kotlin)
-- [Wait for operations](https://algolia.com/doc/api-reference/api-methods/wait-task/?language=kotlin)
+Algolia Kotlin API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).