Skip to content

Commit a0ec47f

Browse files
authored
docs: Remove emojis from index to be consistent with other docs in our packages (#983)
1 parent 233dba3 commit a0ec47f

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

docs/index.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
11
# Shield Documentation
22

3-
## What is Shield? 🤔
3+
## What is Shield?
44

55
Shield is the official authentication and authorization framework for CodeIgniter 4. While
66
it does provide a base set of tools that are commonly used in websites, it is
77
designed to be flexible and easily customizable.
88

9-
### Primary Goals 🥅
9+
### Primary Goals
1010

1111
The primary goals for Shield are:
1212

1313
1. It must be very flexible and allow developers to extend/override almost any part of it.
1414
2. It must have security at its core. It is an auth lib after all.
1515
3. To cover many auth needs right out of the box, but be simple to add additional functionality to.
1616

17-
### Important Features 🌠
17+
### Important Features
1818

19-
* **Session-based Authentication** (traditional **ID/Password** with **Remember-me**)
20-
* **Stateless Authentication** using **Access Token**, **HMAC SHA256 Token**, or **JWT**
21-
* Optional **Email verification** on account registration
22-
* Optional **Email-based Two-Factor Authentication** after login
23-
* **Magic Link Login** when a user forgets their password
24-
* Flexible **Group-based Access Control** (think Roles, but more flexible), and users can be granted additional **Permissions**
25-
* A simple **Auth Helper** that provides access to the most common auth actions
26-
* Save initial settings in your code, so it can be in version control, but can also be updated in the database, thanks to our [Settings](https://github.com/codeigniter4/settings) library
27-
* Highly configurable
28-
* **User Entity** and **User Provider** (`UserModel`) ready for you to use or extend
29-
* Built to extend and modify
30-
* Easily extendable controllers
31-
* All required views that can be used as is or swapped out for your own
19+
- **Session-based Authentication** (traditional **ID/Password** with **Remember-me**)
20+
- **Stateless Authentication** using **Access Token**, **HMAC SHA256 Token**, or **JWT**
21+
- Optional **Email verification** on account registration
22+
- Optional **Email-based Two-Factor Authentication** after login
23+
- **Magic Link Login** when a user forgets their password
24+
- Flexible **Group-based Access Control** (think Roles, but more flexible), and users can be granted additional **Permissions**
25+
- A simple **Auth Helper** that provides access to the most common auth actions
26+
- Save initial settings in your code, so it can be in version control, but can also be updated in the database, thanks to our [Settings](https://github.com/codeigniter4/settings) library
27+
- Highly configurable
28+
- **User Entity** and **User Provider** (`UserModel`) ready for you to use or extend
29+
- Built to extend and modify
30+
- Easily extendable controllers
31+
- All required views that can be used as is or swapped out for your own
3232

33-
### License 📑
33+
### License
3434

3535
Shield is licensed under the MIT License - see the [LICENSE](https://github.com/codeigniter4/shield/blob/develop/LICENSE) file for details.
3636

37-
### Acknowledgements 🙌🏼
37+
### Acknowledgements
3838

3939
Every open-source project depends on it's contributors to be a success. The following users have
4040
contributed in one manner or another in making Shield:
@@ -48,7 +48,7 @@ Made with [contrib.rocks](https://contrib.rocks).
4848
The following articles/sites have been fundamental in shaping the security and best practices used
4949
within this library, in no particular order:
5050

51-
- [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)
52-
- [NIST Digital Identity Guidelines](https://pages.nist.gov/800-63-3/sp800-63b.html)
53-
- [Implementing Secure User Authentication in PHP Applications with Long-Term Persistence (Login with "Remember Me" Cookies) ](https://paragonie.com/blog/2015/04/secure-authentication-php-with-long-term-persistence)
54-
- [Password Storage - OWASP Cheat Sheet Series](https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html)
51+
- [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)
52+
- [NIST Digital Identity Guidelines](https://pages.nist.gov/800-63-3/sp800-63b.html)
53+
- [Implementing Secure User Authentication in PHP Applications with Long-Term Persistence (Login with "Remember Me" Cookies) ](https://paragonie.com/blog/2015/04/secure-authentication-php-with-long-term-persistence)
54+
- [Password Storage - OWASP Cheat Sheet Series](https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html)

0 commit comments

Comments
 (0)