From 38f2b9192166db2af2e8b8a58488d6b97567a656 Mon Sep 17 00:00:00 2001 From: Eric Biggs Date: Mon, 14 Oct 2024 04:15:06 -0400 Subject: [PATCH] Updated readme --- README.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d8f6481..0abe73d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Auth-rs -This is a Rust implementation of the [supabase js auth client](https://github.com/supabase/gotrue-js). As of now, this is alpha software and breaking changes are a certainty. The goal is to have feature parity and an easy-to-use API. +This is a Rust implementation of the [supabase js auth client](https://github.com/supabase/gotrue-js). The goal is to have feature parity and an easy-to-use API. + +Currently this software is functional, but not yet battle-tested or documented. The goal is to go to 1.0.0 by the end of December, 2024. ## Installation @@ -10,12 +12,6 @@ This is a Rust implementation of the [supabase js auth client](https://github.co cargo add supabase-auth ``` -## Differences to the JS client - -It should be noted there are, and will likely always be, differences to the [JS client](https://github.com/supabase/gotrue-js). If something bothers you enough, contributions are welcome. - -Any features which are currently deprecated in the [JS client](https://github.com/supabase/gotrue-js) will not be supported. - ## Usage (Won't be updated until 1.0.0) ```rust @@ -38,7 +34,7 @@ Any features which are currently deprecated in the [JS client](https://github.co - [x] Retrieve User - [x] Reset Password - [x] Change User Data (e.g., Email or password) -- [ ] SSO +- [x] SSO ## Contributions