Skip to content

Commit b514e5c

Browse files
authored
Update readme.md
1 parent 5b462aa commit b514e5c

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

readme.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,22 @@ This is a library developed for Codeigniter 4 that will make the management of u
44

55
The library will automatically manage the registration and login process, with security measures in pace.
66

7-
## Security measures:
8-
- [x] Xss
9-
- [x] SQL Injections
10-
- [x] Session Hijacking
7+
read the documentation [here](https://franky5831.github.io/CodeIgniter4-User-Library-Docs/#/)
8+
9+
## The security measures:
1110
- [x] Captchas
12-
- [ ] Brute force attacks
11+
- [x] Xss prevention
12+
- [x] SQL Injections prevention
13+
- [x] Session Hijacking prevention
14+
- [x] Brute force attacks prevention
1315

1416

1517
## How to install the library:
16-
Run the following command in your terminal:
18+
1. Run the following command in the root of your CodeIgniter 4 project:
1719
```bash
1820
composer require franky5831/codeigniter4-user-library
1921
```
2022

21-
Please remember that this library is still being developed, some features might not be already available and others might not work at all 😊.
23+
2. Copy the configurations you wish to override from the `franky5831/codeigniter4-user-library/src/Config/App.php` file to the `app/Config/App.php` file. The configurations that will not be copied will take the default values from the vendor file, you don't want to copy the `__construct` method from the vendor file.
24+
25+
For any issues or questions, please open an issue on the [GitHub repository](https://github.com/Franky5831/CodeIgniter4-User-Library).

0 commit comments

Comments
 (0)