diff --git a/plugins/two-factor-auth/README.md b/plugins/two-factor-auth/README.md index fdb06045293..289bf64716b 100644 --- a/plugins/two-factor-auth/README.md +++ b/plugins/two-factor-auth/README.md @@ -15,4 +15,33 @@ Sends requests to enable or disable 2FA and handles success and error responses. ## Registering the Component: Registers the TwoFAUser component in the Countly Vue container under the account settings page. -This plugin provides a comprehensive solution for managing 2FA settings within the Countly application, enhancing the security of user accounts by requiring an additional authentication step. \ No newline at end of file +This plugin provides a comprehensive solution for managing 2FA settings within the Countly application, enhancing the security of user accounts by requiring an additional authentication step. + + +## Installation + +To install the 2FA, follow these steps: + +1. Navigate to the 2FA + +```bash +cd two-factor-auth +``` + +2. Install dependencies + +```bash +npm install +``` + +3. Enable the plugin in Countly + +```bash +countly plugin enable two-factor-auth +``` + +4. Restart Countly to apply changes + +```bash +countly restart +``` \ No newline at end of file