Update README to include email verification options

kobra-dev · Mar 19, 2021 · aeadd15 · aeadd15
1 parent c69bb01
commit aeadd15
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/auth/README.md b/auth/README.md
@@ -91,6 +91,9 @@ Create a user with email and password. Wraps the underlying `firebase.auth().cre
 The `useCreateUserWithEmailAndPassword` hook takes the following parameters:
 
 - `auth`: `firebase.auth.Auth` instance for the app you would like to monitor
+- `options`: (optional) `Object` with the following parameters:
+  - `emailVerificationOptions`: (optional) `firebase.auth.ActionCodeSettings` to customise the email verification
+  - `sendEmailVerification`: (optional) `boolean` to trigger sending of an email verification after the user has been created
 
 Returns: