Skip to content
This repository has been archived by the owner on May 10, 2023. It is now read-only.

Commit

Permalink
chore: update API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
noelbot authored and auguwu committed Jul 2, 2022
1 parent 50c8ff5 commit 18b3478
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ <h1 class="">🔍 Meilisearch for Kotlin</h1>
<p class="paragraph"><i>Type-safe and Kotlin Coroutine-based client for Meilisearch</i></p>
</blockquote>
<p class="paragraph"><strong>Meilisearch for Kotlin</strong> is a Meilisearch client for Kotlin developers to take advantage of the Kotlin libraries like <a href="https://github.com/Kotlin/kotlinx.coroutines">kotlinx-coroutines</a> and more.</p>
<p class="paragraph">This is a work in progress, the library currently doesn't support the <a href="https://docs.meilisearch.com/reference/api/settings.html">Settings API</a>, <a href="https://docs.meilisearch.com/reference/api/health.html">Health API</a>, <a href="https://docs.meilisearch.com/reference/api/keys.html">Keys API</a>, or <a href="https://docs.meilisearch.com/reference/api/stats.html#get-stats-of-an-index">Stats API</a></p>
<h2 class=""> WHY</h2>
<p class="paragraph">It sounded like fun, so why not? If any Meilisearch developer or team wants to take care of this project, you can contact me via Email (<code class="lang-kotlin">[email protected]</code>) and if I don't have enough time to maintain it, and it can become an official library.</p>
<p class="paragraph">The library was also built to defunct the official Java library, so it can support the Kotlin libraries us Kotlin developers use and love today.</p>
Expand Down

0 comments on commit 18b3478

Please sign in to comment.