Skip to content

Commit

Permalink
Updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric Biggs committed Sep 16, 2024
1 parent 631ccbb commit 294eeca
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ cargo add supabase-auth

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.

This crate doesn't use pascalCase. Instead we use the snake_case convention.

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)
Expand All @@ -25,6 +23,23 @@ Any features which are currently deprecated in the [JS client](https://github.co
// We're doing cool stuff in here
```

## Features
- [x] Create Client
- [x] Sign In with Email & Password
- [x] Sign In with Phone & Password
- [x] Sign Up with Email & Password
- [x] Sign Up with Phone & Password
- [] Sign In with Third Party Auth (OAuth)
- [] Sign In with Magic Link
- [x] Send Sign-In OTP (Email, SMS, Whatsapp)
- [] Sign In with OTP
- [] Refresh Session
- [] Resend OTP Tokens (Email & SMS)
- [x] Retrieve User
- [] Reset Password
- [] Change User Data (e.g., Email or password)
- [] SSO

## Contributions

Contributors are always welcome. I only ask that you add tests to cover any new functionality, and that any changes pass the existing tests before you put it on my plate. Until this crate reaches 1.0.0 we're in the "move fast and break things" phase. Don't concern yourself with elegance.

0 comments on commit 294eeca

Please sign in to comment.