From 9dee01ebe190d654845901b6b6af425e6f13ac52 Mon Sep 17 00:00:00 2001 From: kenjis Date: Tue, 3 Oct 2023 09:56:21 +0900 Subject: [PATCH 1/2] docs: add emojis --- docs/index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/index.md b/docs/index.md index ee28fc5a8..fa0e40304 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,12 +1,12 @@ # Shield Documentation -## What is Shield? +## What is Shield? 🤔 Shield is the official authentication and authorization framework for CodeIgniter 4. While it does provide a base set of tools that are commonly used in websites, it is designed to be flexible and easily customizable. -### Primary Goals +### Primary Goals 🥅 The primary goals for Shield are: @@ -14,7 +14,7 @@ The primary goals for Shield are: 2. It must have security at its core. It is an auth lib after all. 3. To cover many auth needs right out of the box, but be simple to add additional functionality to. -### Important Features +### Important Features 🌠 * Session-based authentication (traditional ID/Password with Remember-me) * Stateless authentication using Personal Access Tokens @@ -24,11 +24,11 @@ The primary goals for Shield are: * Flexible Groups-based access control (think Roles, but more flexible) * Users can be granted additional Permissions -### License +### License 📑 Shield is licensed under the MIT License - see the [LICENSE](https://github.com/codeigniter4/shield/blob/develop/LICENSE) file for details. -### Acknowledgements +### Acknowledgements 🙌🏼 Every open-source project depends on it's contributors to be a success. The following users have contributed in one manner or another in making Shield: From c0cc2667d48983ea6ee1e4a9d394319eb6d3f655 Mon Sep 17 00:00:00 2001 From: kenjis Date: Tue, 3 Oct 2023 09:56:35 +0900 Subject: [PATCH 2/2] docs: add features Based on https://forum.codeigniter.com/showthread.php?tid=82003 --- docs/index.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/index.md b/docs/index.md index fa0e40304..dc4865884 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,13 +16,19 @@ The primary goals for Shield are: ### Important Features 🌠 -* Session-based authentication (traditional ID/Password with Remember-me) -* Stateless authentication using Personal Access Tokens -* Optional Email verification on account registration -* Optional Email-based Two-Factor Authentication after login -* Magic Link Login when a user forgets their password -* Flexible Groups-based access control (think Roles, but more flexible) -* Users can be granted additional Permissions +* **Session-based Authentication** (traditional **ID/Password** with **Remember-me**) +* **Stateless Authentication** using **Access Token**, **HMAC SHA256 Token**, or **JWT** +* Optional **Email verification** on account registration +* Optional **Email-based Two-Factor Authentication** after login +* **Magic Link Login** when a user forgets their password +* Flexible **Group-based Access Control** (think Roles, but more flexible), and users can be granted additional **Permissions** +* A simple **Auth Helper** that provides access to the most common auth actions +* 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 +* Highly configurable +* **User Entity** and **User Provider** (`UserModel`) ready for you to use or extend +* Built to extend and modify + * Easily extendable controllers + * All required views that can be used as is or swapped out for your own ### License 📑