Skip to content

Commit

Permalink
Readme + version update
Browse files Browse the repository at this point in the history
  • Loading branch information
QuintenJustus committed Mar 11, 2022
1 parent 791d10b commit 50d5ac1
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 3 deletions.
22 changes: 19 additions & 3 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

[![Latest Version on Packagist](https://img.shields.io/packagist/v/protoqol/quasi.svg?style=flat-square)](https://packagist.org/packages/protoqol/quasi)

This package generates API resources with keys preset to their respective table's columns.
Ever thought it was a bit tedious to define an API resource for a large table? This package makes life a bit
simpler by presetting all columns in a Resource, so you can simply remove the ones you don't need, instead of adding the
ones you need.

## Installation

Expand All @@ -14,6 +16,11 @@ You can install the package via composer:
composer require protoqol/quasi
```

Optional - Publish configuration file with:
```php
php artisan vendor:publish --tag=quasi-config
```

## Usage

```php
Expand All @@ -24,14 +31,23 @@ php artisan make:qresource UserResource
php artisan make:qresource UserResource users
```

### Config

```php
// The keys defined in this config will always be excluded from resources - if they exist as a key in the table.
'exclude' => [
// 'id',
],
```

### Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Credits

- [Quinten Justus](https://github.com/protoqol)
- [All Contributors](../../contributors)
- [Quinten Justus](https://github.com/protoqol)
- [All Contributors](../../contributors)

## License

Expand Down
1 change: 1 addition & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"version": "1.0.0",
"name": "protoqol/quasi",
"description": "Quasi",
"keywords": [
Expand Down

0 comments on commit 50d5ac1

Please sign in to comment.