|
1 | 1 | <p align="center"> |
2 | | - <a href="https://clerk.com?utm_source=github&utm_medium=sdk_flutter" target="_blank" rel="noopener noreferrer"> |
3 | | - <picture> |
4 | | - <source media="(prefers-color-scheme: dark)" srcset="https://images.clerk.com/static/logo-dark-mode-400x400.png"> |
5 | | - <img src="https://images.clerk.com/static/logo-light-mode-400x400.png" height="64"> |
6 | | - </picture> |
7 | | - </a> |
8 | | - <br /> |
| 2 | +<img src="https://images.clerk.com/static/logo-light-mode-400x400.png" height="90"> |
9 | 3 | </p> |
10 | 4 |
|
11 | | - |
12 | | -# Clerk Flutter / Pre-release Alpha |
13 | | - |
14 | | -The official [Clerk](https://clerk.com) Flutter client library. |
15 | | - |
16 | | -This package will allow you to authenticate your users and use Clerk services from your Flutter code. |
| 5 | +## Official [Clerk](https://clerk.com) Flutter SDK (Pre-release Alpha) |
17 | 6 |
|
18 | 7 | [](https://pub.dev/packages/clerk_flutter) |
19 | 8 | [](https://pub.dev/packages/clerk_flutter/score) |
20 | 9 | [](https://discord.com/invite/b5rXHjAg7A) |
21 | 10 | [](https://clerk.com/docs) |
22 | 11 | [](https://twitter.com/intent/follow?screen_name=ClerkDev) |
23 | 12 |
|
| 13 | +> ### ⚠️ The Clerk Flutter SDK is in Alpha and not recommended for use in production. ⚠️ |
| 14 | +> ❗️ Breaking changes should be expected until the first stable release (1.0.0) ❗️ |
| 15 | +
|
| 16 | +**Clerk helps developers build user management. We provide streamlined user experiences |
| 17 | +for your users to sign up, sign in, and manage their profile from your Flutter code.** |
| 18 | + |
24 | 19 | ## Requirements |
25 | 20 |
|
26 | 21 | * Flutter >= 3.24.0 |
27 | 22 | * Dart >= 3.5.0 |
28 | 23 |
|
| 24 | +## In Development |
| 25 | + |
| 26 | +* Organization support |
29 | 27 |
|
30 | 28 | ## Example Usage |
31 | 29 |
|
32 | | -To use this package you will need to go to your [Clerk Dashboard](https://dashboard.clerk.com/) |
| 30 | +To use this package you will need to go to your [Clerk Dashboard](https://dashboard.clerk.com/) |
33 | 31 | create an application and copy the public and publishable API keys into your project. |
34 | 32 |
|
35 | 33 | ```dart |
@@ -74,6 +72,7 @@ class _MainAppState extends State<MainApp> { |
74 | 72 | } |
75 | 73 | } |
76 | 74 | ``` |
| 75 | + |
77 | 76 | ## License |
78 | 77 |
|
79 | 78 | This SDK is licensed under the MIT license found in the [LICENSE](./LICENSE) file. |
0 commit comments