Skip to content

Commit

Permalink
updated readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
Johannes Schobel committed Sep 9, 2016
1 parent ca6303a commit 33cec54
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,31 @@ First, add the respective line to your composer file
```json
"require" : {
...
"johannesschobel/dingoquerymapper": "0.1"
"johannesschobel/dingoquerymapper": "dev-master"
}
```
and run `composer install` to install the new component.


Then add the `ServiceProvider` to your `app.php` configuration file, like this:
Then add respective `ServiceProvider` from the package to your `config/app.php` configuration file, like this:
```php
'providers' => [
...,
JohannesSchobel\DingoQueryMapper\DingoQueryMapperServiceProvider::class,
],
```

If you want, you can overwrite the provided configuration with the following command:
If you want, you can overwrite the basic configuration using the following command:
```php
php artisan vendor:publish --provider="JohannesSchobel\DingoQueryMapper\DingoQueryMapperServiceProvider" --tag="config"
```
You can customize the `limit` parameter or the query parameters to be excluded from the service provider.
This will copy the `dingoquerymapper` configuration file to your `config` folder. Using this file, you can
customize the `limit` parameter or the query parameters to be excluded from the service provider.

# Usage
## Example
In order to use the plugin, simply create a new instance from `DingoQueryMapperBuilder` and pass the request. The rest is handled by the `Builder`.
In order to use the plugin, simply create a new instance from `DingoQueryMapperBuilder` and pass the request.
The rest is handled by the `Builder` itself.

Consider the following example:
```php
Expand Down

0 comments on commit 33cec54

Please sign in to comment.