Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
minasm committed Oct 9, 2024
1 parent 1488c8d commit 15f400f
Showing 1 changed file with 5 additions and 12 deletions.
17 changes: 5 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
### Create revisions for any Eloquent model along with its relationships

[![Build Status](https://travis-ci.org/Neurony/laravel-revisions.svg?branch=master)](https://travis-ci.org/Neurony/laravel-revisions)
[![StyleCI](https://github.styleci.io/repos/170915589/shield?branch=master)](https://github.styleci.io/repos/170915589)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Neurony/laravel-revisions/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Neurony/laravel-revisions/?branch=master)
[![Build Status](https://github.com/minasm/laravel-revisions/workflows/tests/badge.svg)](https://github.com/minasm/laravel-revisions/actions/)

- [Overview](#overview)
- [Installation](#installation)
Expand All @@ -17,7 +15,7 @@ This package allows you to create revisions for any Eloquent model record along

* When a revision is created, it gets stored inside the `revisions` database table.
* Revisions are created automatically on model update, using the `updated` Eloquent event
* Revisions can also can be created manually by using the `saveAsRevision()`
* Revisions can also be created manually by using the `saveAsRevision()`
* When a record is force deleted, all its revisions will also be removed automatically, using the `deleted` Eloquent event

As already mentioned, this package is capable of revisioning entire relationships alongside the model record.
Expand All @@ -31,19 +29,19 @@ Relationship types that can be revisioned: `hasOne`, `morphOne`, `hasMany`, `mor
Install the package via Composer (for **Laravel 6.0 and above**):

```
composer require neurony/laravel-revisions
composer require minas/laravel-revisions
```

Install the package via Composer (for **Laravel 5.8**):

```
composer require neurony/laravel-revisions:3.1.0
composer require minas/laravel-revisions:3.1.0
```

Install the package via Composer (for **Laravel 5.7 and below**):

```
composer require neurony/laravel-revisions:2.0.0
composer require minas/laravel-revisions:2.0.0
```

Publish the config file with:
Expand Down Expand Up @@ -351,13 +349,8 @@ class YourModel extends Model

### Credits

- [Andrei Badea](https://github.com/zbiller)
- [All Contributors](../../contributors)

### Security

If you discover any security related issues, please email andrei.badea@neurony.ro instead of using the issue tracker.

### License

The MIT License (MIT). Please see [LICENSE](LICENSE.md) for more information.
Expand Down

0 comments on commit 15f400f

Please sign in to comment.