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

chore: Add link to supabase-kt to in prep for archiving the repo #6

Merged
merged 2 commits into from
Nov 1, 2023
Merged
Changes from 1 commit
Commits
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
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Kotlin Client for GoTrue

> **Warning**
> This repository is archived. Use [supabase-kt](https://github.com/supabase-community/supabase-kt) instead to use Supabase in your Android application.
dshukertjr marked this conversation as resolved.
Show resolved Hide resolved

Kotlin JVM client for [Netlify's GoTrue API](https://github.com/netlify/gotrue).

Comes with DTOs for the responses to enable type-safe access.
Expand All @@ -11,6 +14,7 @@ Comes with DTOs for the responses to enable type-safe access.
## Installation

Maven

```xml
<dependency>
<groupId>io.supabase</groupId>
Expand All @@ -21,11 +25,11 @@ Maven
```

Gradle

```groovy
implementation 'io.supabase:gotrue-kt:{version}'
```


## Usage

```kotlin
Expand All @@ -43,7 +47,7 @@ try {
"admin" = true
)
)

println(updatedUser.updatedAt)
} catch (exc: GoTrueHttpException) {
// Exception is thrown on bad status (anything above 300)
Expand All @@ -53,7 +57,7 @@ try {

You can also customize the DTO for example if you turn off email verification

`````kotlin
```kotlin
data class CustomGoTrueUserResponse(
val accessToken: String,
val tokenType: String,
Expand All @@ -72,7 +76,7 @@ GoTrueClient.customApacheJacksonGoTrueClient<CustomGoTrueUserResponse, GoTrueTok
url = "<base-url>",
headers = mapOf("Authorization" to "foo", "apiKey" to "bar")
)
`````
```

If you are using [supabase](https://supabase.io/), the base URL will be `https://<your-project-id>.supabase.co/auth/v1`

Expand Down