Skip to content

Commit 205e4f2

Browse files
committed
update readme structure
1 parent 6b4865a commit 205e4f2

File tree

1 file changed

+28
-37
lines changed

1 file changed

+28
-37
lines changed

README.md

Lines changed: 28 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,44 @@
1-
# Laravel Doctrine ACL
1+
<p align="center">
2+
<img src="https://placehold.co/10x10/337ab7/337ab7.png" width="100%" height="15px">
3+
<img width="450px" src="https://github.com/laravel-doctrine/orm/blob/3.0.x/docs/banner.png"/>
4+
</p>
25

3-
[![Latest Version on Packagist](https://img.shields.io/packagist/v/sowl/laravel-doctrine-acl.svg?style=flat-square)](https://packagist.org/packages/sowl/laravel-doctrine-acl)
4-
[![Build Status](https://github.com/ScholarshipOwl/laravel-doctrine-acl/actions/workflows/php.yml/badge.svg)](https://github.com/ScholarshipOwl/laravel-doctrine-acl/actions)
5-
[![Total Downloads](https://img.shields.io/packagist/dt/sowl/laravel-doctrine-acl.svg?style=flat-square)](https://packagist.org/packages/sowl/laravel-doctrine-acl)
6-
[![License](https://img.shields.io/packagist/l/sowl/laravel-doctrine-acl.svg?style=flat-square)](LICENSE.md)
6+
Laravel Doctrine ACL
7+
====================
78

89
Laravel Doctrine ACL is a package that provides RBAC (Role-Based Access Control) functionality for Laravel applications using Doctrine. It allows you to manage roles, permissions, and organisations, and seamlessly integrates with Laravel's Authorization system.
910

10-
Fork of the [laravel-doctrine/acl](https://github.com/laravel-doctrine/acl) package (no longer active).
11-
12-
## Features
11+
[![Build Status](https://github.com/ScholarshipOwl/laravel-doctrine-acl/actions/workflows/php.yml/badge.svg)](https://github.com/ScholarshipOwl/laravel-doctrine-acl/actions)
12+
[![Code Coverage](https://codecov.io/gh/laravel-doctrine/acl/graph/badge.svg?token=3CpQzDXOWX)](https://codecov.io/gh/laravel-doctrine/acl)
13+
[![PHPStan](https://img.shields.io/badge/PHPStan-level%201-brightgreen.svg)](https://img.shields.io/badge/PHPStan-level%201-brightgreen.svg)
14+
[![Documentation](https://readthedocs.org/projects/laravel-doctrine-acl-official/badge/?version=latest)](https://laravel-doctrine-acl-official.readthedocs.io/en/latest/)
15+
[![Packagist Downloads](https://img.shields.io/packagist/dd/laravel-doctrine/acl)](https://packagist.org/packages/laravel-doctrine/acl)
1316

14-
- User can have Permissions
15-
- User can have Roles
16-
- User and Roles can have Permissions
17-
- User can belong to Organisation(s)
18-
- Seamless integration with Laravel's Authorization system
19-
- PHP 8.2+ with Attributes support (annotations removed)
17+
Installation
18+
------------
2019

21-
## Installation
20+
Via composer:
2221

2322
```bash
24-
composer require sowl/laravel-doctrine-acl
23+
composer require laravel-doctrine/acl
2524
```
2625

27-
## Versions
28-
29-
Version | Supported Laravel Versions
30-
:-------|:------
31-
^1.5 | 11.x
32-
^2.0 | 12.x
26+
The ServiceProvider and Facades are autodiscovered.
3327

34-
## Quick Start
28+
Publish the configuration:
3529

36-
1. Publish the configuration:
37-
```bash
38-
php artisan vendor:publish --tag="config" --provider="LaravelDoctrine\\ACL\\AclServiceProvider"
39-
```
40-
2. Configure your entities and relationships using PHP 8 attributes (see examples in the docs).
41-
3. Use the built-in traits and contracts to add ACL features to your User, Role, Permission, and Organisation entities.
42-
43-
## Documentation
44-
45-
Full documentation is available in the [`docs/`](./docs) folder.
30+
```bash
31+
php artisan vendor:publish --tag="config" --provider="LaravelDoctrine\ACL\AclServiceProvider"
32+
```
4633

47-
## Contributing
34+
Documentation
35+
-------------
4836

49-
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details and a code of conduct.
37+
Full documentation at https://laravel-doctrine-orm-official.readthedocs.io
38+
or in the docs directory.
5039

51-
## License
40+
Versions
41+
--------
5242

53-
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
43+
* Version 2 supports DBAL ^4.0, ORM ^3.0, and PHP 8.2.
44+
* Version 1 supports Laravel 6 - 11, DBAL ^2.0, ORM ^2.0, and PHP ^5.5 - ^8.0.

0 commit comments

Comments
 (0)