Update doc

koji-1009 · Feb 25, 2020 · 647348f · 647348f
1 parent dc30dba
commit 647348f
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,17 @@
+## 0.2.0
+
+Second beta release.
+
+### Breaking change
+
+- Change set provider function to enum
+- Change PlatformUser to Bool when success `startUi`
+
+### Minor change
+
+- Update libs
+- Update api doc
+
 ## 0.1.0
 
 First beta release of flutter plugin for Firebase Auth UI.

diff --git a/README.md b/README.md
@@ -11,3 +11,20 @@ Check documents and setup your firebase project.
 
 * iOS : <https://firebase.google.com/docs/auth/ios/firebaseui>
 * Android : <https://firebase.google.com/docs/auth/android/firebaseui>
+
+## How to use
+
+```
+// Set provider
+final providers = [
+  AuthUiItem.AuthEmail,
+  AuthUiItem.AuthApple,
+  AuthUiItem.AuthGithub,
+  AuthUiItem.AuthGoogle,
+  AuthUiItem.AuthMicrosoft,
+  AuthUiItem.AuthYahoo,
+];
+
+final tosAndPrivacyPolicy = TosAndPrivacyPolicy(Terms of Service URL, Privacy Policy URL);
+final isSuccess = await FlutterAuthUi.startUi(providers, tosAndPrivacyPolicy);
+```