Skip to content

Commit

Permalink
update readme, remove Laravel 10 from tests
Browse files Browse the repository at this point in the history
  • Loading branch information
sheadawson committed Oct 17, 2024
1 parent e07656f commit 77784ee
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/phpstan.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.2'
php-version: '8.3'
coverage: none

- name: Install composer dependencies
Expand Down
5 changes: 1 addition & 4 deletions .github/workflows/run-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,12 @@ jobs:
matrix:
os: [ ubuntu-latest, windows-latest ]
php: [ 8.3, 8.2 ]
laravel: [ 11.*, 10.* ]
laravel: [ 11.* ]
stability: [ prefer-lowest, prefer-stable ]
include:
- laravel: 11.*
testbench: 9.*
carbon: ^2.63
- laravel: 10.*
testbench: 8.*
carbon: ^2.63

name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}

Expand Down
21 changes: 13 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
# Introduction
# Laravel Revisor

Laravel Revisor aims to provide the maximum power and flexibility possible in versioned record management, while maintaining a very low tolerance for complexity. 
[![Latest Version on Packagist](https://img.shields.io/packagist/v/indracollective/laravel-revisor.svg?style=flat-square)](https://packagist.org/packages/indracollective/laravel-revisor)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/indracollective/laravel-revisor/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/indracollective/laravel-revisor/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/indracollective/laravel-revisor/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/indracollective/laravel-revisor/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/indracollective/laravel-revisor.svg?style=flat-square)](https://packagist.org/packages/indracollective/laravel-revisor)

### Features
**Laravel Revisor provides robust draft, publishing and versioning for Laravel Eloquent Models.**

✅ Separate, complete database tables for draft, published and version history records of each Model. Drafts and versions of recods are not second class citizens stored in single column json blobs
There are a good handful of Laravel versioning packages out there with varying approaches. Revisor aims to overcome their different trade-offs, offering maximum power, flexibility and interoperability while maintaining a low tolerance for complexity.

✅ Migration API for managing draft, published and version history tables with no additional overhead
## Installation

✅ Easy context management for setting the appropriate reading/writing "mode" at all levels of operation - global config, middleware, mode isolation callbacks and query builder modifiers.
```bash
composer require indracollective/laravel-revisor
```

✅ Simple and intuitive API for drafting, publishing and versioning records
## Documentation

✅ High configurability and excellent documentation
[laravel-revisor.indracollective.dev](https://laravel-revisor.indracollective.dev)
2 changes: 1 addition & 1 deletion docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Laravel Revisor provides robust draft, publishing and versioning for Laravel Eloquent Models.

There are a good handful of Laravel versioning packages out there with varying approaches. Revisor aims to overcome their different trade-offs, offering maximum power, flexibility and interoperability with minimum exposure to complexity.
There are a good handful of Laravel versioning packages out there with varying approaches. Revisor aims to overcome their different trade-offs, offering maximum power, flexibility and interoperability while maintaining a low tolerance for complexity.

## Design Goals

Expand Down

0 comments on commit 77784ee

Please sign in to comment.