66[ ![ Coverage Status] ( https://coveralls.io/repos/github/codeigniter4/shield/badge.svg?branch=develop )] ( https://coveralls.io/github/codeigniter4/shield?branch=develop )
77
88Shield is an authentication and authorization framework for CodeIgniter 4. While it does provide a base set of tools
9- that are commonly used in websites, it is designed to be flexible and easily customizable.
9+ that are commonly used in websites, it is designed to be flexible and easily customizable.
1010
11- The primary goals for Shield are:
11+ The primary goals for Shield are:
12121 . It must be very flexible and allow developers to extend/override almost any part of it.
13132 . It must have security at its core. It is an auth lib after all.
14143 . To cover many auth needs right out of the box, but be simple to add additional functionality to.
1515
1616## Authentication Methods
1717
18- Shield provides two primary methods of authentication out of the box:
18+ Shield provides two primary methods of authentication out of the box:
1919
20- ** Session-based**
20+ ** Session-based**
2121
2222This is your typical email/username/password system you see everywhere. It includes a secure "remember me" functionality.
23- This can be used for standard web applications, as well as for single page applications. Includes full controllers and
23+ This can be used for standard web applications, as well as for single page applications. Includes full controllers and
2424basic views for all standard functionality, like registration, login, forgot password, etc.
2525
26- ** Personal Access Codes**
26+ ** Personal Access Codes**
2727
2828These are much like the access codes that GitHub uses, where they are unique to a single user, and a single user
29- can have more than one. This can be used for API authentication of third-party users, and even for allowing
30- access for a mobile application that you build.
29+ can have more than one. This can be used for API authentication of third-party users, and even for allowing
30+ access for a mobile application that you build.
3131
3232## Getting Started
3333
@@ -45,11 +45,11 @@ Installation is done through Composer.
4545
4646 > composer require codeigniter4/shield
4747
48- See the [ docs] ( docs ) folder more specific instructions on installation and usage recommendations.
48+ See the [ docs] ( docs/index.md ) for more specific instructions on installation and usage recommendations.
4949
5050## Contributing
5151
52- Shield does accept and encourage contributions from the community in any shape. It doesn't matter
52+ Shield does accept and encourage contributions from the community in any shape. It doesn't matter
5353whether you can code, write documentation, or help find bugs, all contributions are welcome.
5454
5555## License
@@ -58,8 +58,8 @@ This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) f
5858
5959## Acknowledgements
6060
61- Every open-source project depends on it's contributors to be a success. The following users have
62- contributed in one manner or another in making Shield:
61+ Every open-source project depends on it's contributors to be a success. The following users have
62+ contributed in one manner or another in making Shield:
6363
6464<a href =" https://github.com/codeigniter4/shield/graphs/contributors " >
6565 <img src =" https://contrib.rocks/image?repo=codeigniter4/shield " />
@@ -68,7 +68,7 @@ contributed in one manner or another in making Shield:
6868Made with [ contrib.rocks] ( https://contrib.rocks ) .
6969
7070The following articles/sites have been fundamental in shaping the security and best practices used
71- within this library, in no particular order:
71+ within this library, in no particular order:
7272
7373- [ Google Cloud: 13 best practices for user account, authentication, and password management, 2021 edition] ( https://cloud.google.com/blog/products/identity-security/account-authentication-and-password-management-best-practices )
7474- [ NIST Digital Identity Guidelines] ( https://pages.nist.gov/800-63-3/sp800-63b.html )
0 commit comments