Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Proziam committed Oct 14, 2024
1 parent e6d31d4 commit 38f2b91
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand All @@ -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

Expand Down

0 comments on commit 38f2b91

Please sign in to comment.