Skip to content

Commit afd8b7d

Browse files
docs(readme): enhance documentation with feature highlights and contribution guidelines
1 parent 8a9f2ac commit afd8b7d

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
# flutter_policy_engine
22

3-
flutter_policy_engine is a lightweight and extensible policy engine for Flutter that lets you define, manage, and evaluate access control rules declaratively using ABAC (Attribute-Based Access Control) or RBAC models.
3+
A lightweight, extensible policy engine for Flutter. Define, manage, and evaluate access control rules declaratively using ABAC (Attribute-Based Access Control) or RBAC (Role-Based Access Control) models.
4+
5+
## Features
6+
7+
- Attribute-Based and Role-Based Access Control (ABAC/RBAC)
8+
- Declarative rule definitions
9+
- Extensible and modular design
10+
- Easy integration with Flutter apps
411

512
## Installation
613

7-
Make sure you have [Flutter](https://docs.flutter.dev/get-started/install) and [Dart](https://dart.dev/get-dart) installed. It is recommended to use [FVM](https://fvm.app/) for Flutter version management.
14+
Ensure you have [Flutter](https://docs.flutter.dev/get-started/install) and [Dart](https://dart.dev/get-dart) installed. [FVM](https://fvm.app/) is recommended for managing Flutter versions.
815

916
```bash
1017
# Clone the repository and enter the directory
11-
# git clone <repo-url>
18+
git clone <repo-url>
1219
cd flutter_policy_engine
1320

1421
# Run the setup script (requires bash, Flutter, Node.js, and npm)
@@ -17,27 +24,26 @@ cd flutter_policy_engine
1724

1825
The setup script will:
1926

20-
- Check for Flutter and FVM installation
21-
- Install the Flutter version defined in `.fvm/fvm_config.json` (if present)
27+
- Check for Flutter and FVM
28+
- Install the Flutter version from `.fvm/fvm_config.json` (if present)
2229
- Install Dart/Flutter dependencies (`pub get`)
2330
- Install Node.js dependencies (if `package.json` exists)
2431
- Initialize Husky for git hooks (if present)
2532
- Add `.fvm/` to `.gitignore` if needed
2633

27-
## Scripts & Tooling
28-
29-
- `./setup.sh`: Automates environment setup.
30-
- `fvm flutter test` or `flutter test`: Runs tests.
31-
- Husky and Commitlint are set up for commit quality (requires Node.js).
34+
## Contributing
3235

33-
## Linting
36+
Contributions are welcome! Please:
3437

35-
This project uses [flutter_lints](https://pub.dev/packages/flutter_lints) to enforce good coding practices. You can customize rules in `analysis_options.yaml`.
38+
- Follow the existing code style and patterns
39+
- Write clear commit messages (Commitlint and Husky are enabled)
40+
- Add or update tests for new features or bug fixes
41+
- Open a pull request with a clear description
3642

3743
## License
3844

3945
MIT © 2025 David Alejandro Garcia Ruiz
4046

4147
---
4248

43-
> If you use VSCode, restart your terminal after setup to ensure FVM is properly detected.
49+
> **Tip:** If you use VSCode, restart your terminal after setup to ensure FVM is properly detected.

0 commit comments

Comments
 (0)