Skip to content

docs: improve README with usage example and known limitations #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

docs: improve README with usage example and known limitations #210

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 21 additions & 1 deletion packages/clerk_flutter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ for your users to sign up, sign in, and manage their profile from your Flutter c

## In Development

* Organization support
* Organization support


## Example Usage

Expand Down Expand Up @@ -66,6 +67,25 @@ class ExampleApp extends StatelessWidget {
}
```


## ⚠️ Limitations (Beta)

This SDK is still under development. Known limitations:

- No custom OAuth logic (`signInWithProvider`)
- No token support (`getToken`)
- Only basic authentication and user profile support
- No organization or session listeners (yet)


### ⚠️ Currently Unsupported Methods

Some methods available in Clerk JS/Web SDKs are not yet supported in Flutter:

- ❌ `signInWithProvider()` → Use `ClerkAuthentication()` instead
- ❌ `getToken()` → Use `session.id` or secure backend verification


## License

This SDK is licensed under the MIT license found in the [LICENSE](./LICENSE) file.