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

Commit

Permalink
chore: Add link to supabase-kt to in prep for archiving the repo (#6)
Browse files Browse the repository at this point in the history
* chore: add link to supabase-kt to warn users about archive

* Update README.md
  • Loading branch information
dshukertjr authored Nov 1, 2023
1 parent 59c7188 commit 17c96b1
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# 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 Kotlin projects.

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 +15,7 @@ Comes with DTOs for the responses to enable type-safe access.
## Installation

Maven

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

Gradle

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


## Usage

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

println(updatedUser.updatedAt)
} catch (exc: GoTrueHttpException) {
// Exception is thrown on bad status (anything above 300)
Expand All @@ -53,7 +58,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 +77,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

0 comments on commit 17c96b1

Please sign in to comment.