Skip to content

Commit 46550e1

Browse files
committed
docs(README): update Key Capabilities section with more detail and clarity
- Improve authentication description: passwordless email sign-in and role-aware login - Refine RBAC explanation: dual-role system for app features and admin functions - Expand user preferences: include followed topics - Enhance data management: add topics to core news data - Update dashboard summary: include topics in key data points
1 parent b915b5d commit 46550e1

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,28 +17,29 @@ management dashboard](https://github.com/headlines-toolkit/ht-dashboard).
1717
## ✨ Key Capabilities
1818

1919
* 🔒 **Flexible & Secure Authentication:** Provide seamless user access with
20-
a unified system supporting passwordless sign-in, anonymous guest
21-
accounts, and a secure, context-aware login flow for privileged dashboard
22-
users (e.g., 'admin', 'publisher').
20+
a unified system supporting passwordless email sign-in, anonymous guest
21+
accounts, and a secure, role-aware login flow for privileged dashboard
22+
users.
2323

24-
* ⚡️ **Flexible Role-Based Access Control (RBAC):** Implement granular
25-
permissions with a flexible, multi-role system. Assign multiple roles to
26-
users (e.g., 'admin', 'publisher', 'premium_user') to precisely control
27-
access to different API features and data management capabilities.
24+
* ⚡️ **Granular Role-Based Access Control (RBAC):** Implement precise
25+
permissions with a dual-role system (`appRole` for application features,
26+
`dashboardRole` for admin functions) to control access to API features
27+
and data management capabilities.
2828

2929
* ⚙️ **Synchronized App Settings:** Ensure a consistent and personalized user
3030
experience across devices by effortlessly syncing application preferences
3131
like theme, language, font styles, and more.
3232

3333
* 👤 **Personalized User Preferences:** Enable richer user interactions by
34-
managing and syncing user-specific data such as saved headlines, followed sources, or other personalized content tailored to individual users.
34+
managing and syncing user-specific data such as saved headlines, followed
35+
sources, and followed topics tailored to individual users.
3536

3637
* 💾 **Robust Data Management:** Securely manage core news data (headlines,
37-
categories, sources) through a well-structured API that supports flexible
38+
topics, sources) through a well-structured API that supports flexible
3839
querying and sorting for dynamic content presentation.
3940

4041
* 📊 **Dynamic Dashboard Summary:** Access real-time, aggregated metrics on
41-
key data points like total headlines, categories, and sources, providing
42+
key data points like total headlines, topics, and sources, providing
4243
an at-a-glance overview for administrative dashboards.
4344

4445
* 🔧 **Solid Technical Foundation:** Built with Dart and the high-performance

0 commit comments

Comments
 (0)