Skip to content

Commit 36a0621

Browse files
committed
docs: update README.md
1 parent 6be3162 commit 36a0621

1 file changed

Lines changed: 20 additions & 16 deletions

File tree

README.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
[![Architecture](https://github.com/codeigniter4/shield/workflows/Deptrac/badge.svg)](https://github.com/codeigniter4/shield/actions/workflows/deptrac.yml)
99
[![Coverage Status](https://coveralls.io/repos/github/codeigniter4/shield/badge.svg?branch=develop)](https://coveralls.io/github/codeigniter4/shield?branch=develop)
1010

11-
Shield is an authentication and authorization framework for CodeIgniter 4. While it does provide a base set of tools
11+
Shield is the official authentication and authorization framework for CodeIgniter 4.
12+
While it does provide a base set of tools
1213
that are commonly used in websites, it is designed to be flexible and easily customizable.
1314

1415
The primary goals for Shield are:
@@ -18,43 +19,44 @@ The primary goals for Shield are:
1819

1920
## Authentication Methods
2021

21-
Shield provides two primary methods **Session-based** and **Personal Access Codes**
22-
of authentication out of the box.
22+
Shield provides two primary methods **Session-based** and **Access Token**
23+
authentication out of the box.
2324

24-
It also provides **JSON Web Tokens** authentication.
25+
It also provides **HMAC SHA256 Token** and **JSON Web Token** authentication.
2526

2627
### Session-based
2728

28-
This is your typical email/username/password system you see everywhere. It includes a secure "remember me" functionality.
29+
This is your typical email/username/password system you see everywhere. It includes a secure "remember-me" functionality.
2930
This can be used for standard web applications, as well as for single page applications. Includes full controllers and
3031
basic views for all standard functionality, like registration, login, forgot password, etc.
3132

32-
### Personal Access Codes
33+
### Access Token
3334

34-
These are much like the access codes that GitHub uses, where they are unique to a single user, and a single user
35+
These are much like the access tokens that GitHub uses, where they are unique to a single user, and a single user
3536
can have more than one. This can be used for API authentication of third-party users, and even for allowing
3637
access for a mobile application that you build.
3738

38-
### HMAC - SHA256
39+
### HMAC SHA256 Token
3940

40-
This is a slightly more complicated improvement on Access Codes/Tokens. The main advantage with HMAC is the shared Secret Key
41+
This is a slightly more complicated improvement on Access Token authentication.
42+
The main advantage with HMAC is the shared Secret Key
4143
is not passed in the request, but is instead used to create a hash signature of the request body.
4244

43-
### JSON Web Tokens
45+
### JSON Web Token
4446

4547
JWT or JSON Web Token is a compact and self-contained way of securely transmitting
4648
information between parties as a JSON object. It is commonly used for authentication
4749
and authorization purposes in web applications.
4850

49-
## Some Important Features
51+
## Important Features
5052

51-
* Session-based authentication (traditional email/password with remember me)
53+
* Session-based authentication (traditional ID/Password with Remember-me)
5254
* Stateless authentication using Personal Access Tokens
5355
* Optional Email verification on account registration
5456
* Optional Email-based Two-Factor Authentication after login
55-
* Magic Login Links when a user forgets their password
56-
* Flexible groups-based access control (think roles, but more flexible)
57-
* Users can be granted additional permissions
57+
* Magic Link Login when a user forgets their password
58+
* Flexible Groups-based access control (think Roles, but more flexible)
59+
* Users can be granted additional Permissions
5860

5961
See the [An Official Auth Library](https://codeigniter.com/news/shield) for more Info.
6062

@@ -71,6 +73,7 @@ Usage of Shield requires the following:
7173
### Installation
7274

7375
Installation is done through Composer.
76+
7477
```console
7578
composer require codeigniter4/shield
7679
```
@@ -81,14 +84,15 @@ See the <a href="https://codeigniter4.github.io/shield/" target="_blank">docs</a
8184

8285
Shield does accept and encourage contributions from the community in any shape. It doesn't matter
8386
whether you can code, write documentation, or help find bugs, all contributions are welcome.
87+
see the [CONTRIBUTING.md](CONTRIBUTING.md) file for details.
8488

8589
## License
8690

8791
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
8892

8993
## Acknowledgements
9094

91-
Every open-source project depends on it's contributors to be a success. The following users have
95+
Every open-source project depends on its contributors to be a success. The following users have
9296
contributed in one manner or another in making Shield:
9397

9498
<a href="https://github.com/codeigniter4/shield/graphs/contributors">

0 commit comments

Comments
 (0)