Skip to content

Commit 50d5ac1

Browse files
committed
Readme + version update
1 parent 791d10b commit 50d5ac1

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

.github/README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

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

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

911
## Installation
1012

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

19+
Optional - Publish configuration file with:
20+
```php
21+
php artisan vendor:publish --tag=quasi-config
22+
```
23+
1724
## Usage
1825

1926
```php
@@ -24,14 +31,23 @@ php artisan make:qresource UserResource
2431
php artisan make:qresource UserResource users
2532
```
2633

34+
### Config
35+
36+
```php
37+
// The keys defined in this config will always be excluded from resources - if they exist as a key in the table.
38+
'exclude' => [
39+
// 'id',
40+
],
41+
```
42+
2743
### Changelog
2844

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

3147
## Credits
3248

33-
- [Quinten Justus](https://github.com/protoqol)
34-
- [All Contributors](../../contributors)
49+
- [Quinten Justus](https://github.com/protoqol)
50+
- [All Contributors](../../contributors)
3551

3652
## License
3753

composer.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
2+
"version": "1.0.0",
23
"name": "protoqol/quasi",
34
"description": "Quasi",
45
"keywords": [

0 commit comments

Comments
 (0)