From 7712482a33179df86017ea3aa56b349c3cb50c3d Mon Sep 17 00:00:00 2001 From: Yusuf Khasbulatov Date: Fri, 10 Feb 2023 01:09:42 +0100 Subject: [PATCH] docs(user verification): Update documentation to include new email/phone verification settings This commit updates the documentation to include information about the new email/phone verification settings added in a previous commit. The updated documentation ensures that developers and users are aware of the new feature and how to use it in their applications. --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a14b3aa..1e6ae19 100644 --- a/README.md +++ b/README.md @@ -41,15 +41,16 @@ APPWRITE = { 'PROJECT_ENDPOINT': 'https://example.com/v1', 'PROJECT_ID': 'PROJECT_ID', 'PROJECT_API_KEY': 'PROJECT_API_KEY', - 'USER_ID_HEADER': 'USER_ID', } ``` -| Setting | Default | Description | -|--------------------|-----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| -| `PROJECT_ENDPOINT` | | The endpoint of your Appwrite project. You can find this in the Appwrite console under Settings > General. | -| `PROJECT_ID` | | The ID of your Appwrite project. You can find this in the Appwrite console under Settings > General. | -| `PROJECT_API_KEY` | | The API key of your Appwrite project. You can find this in the Appwrite console under Settings > API Keys. | -| `USER_ID_HEADER` | HTTP_USER_ID | The header name that will be used to store the user ID. | +| Setting | Default | Description | +|--------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `PROJECT_ENDPOINT` | | The endpoint of your Appwrite project. You can find this in the Appwrite console under Settings > General. | +| `PROJECT_ID` | | The ID of your Appwrite project. You can find this in the Appwrite console under Settings > General. | +| `PROJECT_API_KEY` | | The API key of your Appwrite project. You can find this in the Appwrite console under Settings > API Keys. | +| `USER_ID_HEADER` | HTTP_USER_ID | The header name that will be used to store the user ID. | +| `VERIFY_EMAIL` | False | If set to `True`, the middleware will check if the user's email address has been verified in Appwrite before authenticating the user. If the email address has not been verified, the user will not be authenticated. | +| `VERIFY_PHONE` | False | If set to `True`, the middleware will check if the user's phone number has been verified in Appwrite before authenticating the user. If the phone number has not been verified, the user will not be authenticated. | ## How it works This middleware class will get the user ID from the header specified in the `USER_ID_HEADER` setting.