Skip to content

Commit 25f1746

Browse files
Merge pull request #5729 from Countly/SER-2094
[SER-2094] improve README.md
2 parents 92a995c + 41aba7e commit 25f1746

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

plugins/two-factor-auth/README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,33 @@ Sends requests to enable or disable 2FA and handles success and error responses.
1515
## Registering the Component:
1616

1717
Registers the TwoFAUser component in the Countly Vue container under the account settings page.
18-
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.
18+
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.
19+
20+
21+
## Installation
22+
23+
To install the 2FA, follow these steps:
24+
25+
1. Navigate to the 2FA
26+
27+
```bash
28+
cd two-factor-auth
29+
```
30+
31+
2. Install dependencies
32+
33+
```bash
34+
npm install
35+
```
36+
37+
3. Enable the plugin in Countly
38+
39+
```bash
40+
countly plugin enable two-factor-auth
41+
```
42+
43+
4. Restart Countly to apply changes
44+
45+
```bash
46+
countly restart
47+
```

0 commit comments

Comments
 (0)