From 522f1c0ee2e627342269f20ef81d6682137651d1 Mon Sep 17 00:00:00 2001
From: Maxim <maksa988ua@gmail.com>
Date: Tue, 27 Aug 2019 14:06:06 +0300
Subject: [PATCH] Update dependencies and readme

---
 README.md     | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++
 composer.json |  3 +-
 2 files changed, 83 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a43ceb8..d0604c8 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,87 @@
 # Laravel Filters
 Filter models for Laravel.
 
+#### PHP >= 5.6.4, Laravel >= 5.3
+
+## Installation
+
+Filters for Laravel is installed via [Composer](https://getcomposer.org/).
+For most uses, you will need to require `maksa988/laravel-filters` and an individual gateway:
+
+```bash
+composer require maksa988/laravel-filters
+```
+
+## Usage
+
+First you need to create a filter, you can do this using the artisan command `php artisan make:filter PostFilter`.
+
+After that the `App\Filters` directory will be created and the `PostFilter` filter will be created there.
+
+```php
+<?php
+
+namespace App\Filters;
+
+use Maksa988\LaravelFilters\Filters;
+
+class PostFilter extends Filters
+{
+    /**
+     * Available filters
+     *
+     * @var array
+     */
+    protected $filters = [
+        'title',
+    ];
+
+    /**
+     * @param string $value
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function title($value)
+    {
+        return $this->builder->where('title', $value);
+    }
+}
+```
+
+In the filter class, create methods whose names you must specify in the `$filters` array. The method will receive the value that will be accepted from the request.
+
+Elequent builder is available in the class to compile a query that will be called when filtering data.
+
+```php
+/**
+ * Display a listing of the resource.
+ *
+ * @param Post $post
+ * @param PostFilter $filter
+ * @return \Illuminate\View\View
+ */
+public function index(Post $post, PostFilter $filter)
+{
+    $list = $post->filter($filter)->paginate(20);
+
+    return $this->view(compact('list'));
+}
+```
+
+You can use the filter in the model by simply calling the scope `filter`, passing the class with the filter there.
+
+In order for scope to be available in the model, you need to connect trait `Maksa988\LaravelFilters\Traits\HasFilters`:
+
+```php
+class Post extends Model
+{
+    use HasFilters;
+}
+```
+
+To filter data by the title filter in the address, just pass a field with that name, for example, this can be done using GET:
+
+`http://example.com/posts?title=Post%20title`
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
diff --git a/composer.json b/composer.json
index 69af7d2..058c281 100644
--- a/composer.json
+++ b/composer.json
@@ -16,7 +16,8 @@
         "php": ">=5.6.4",
         "illuminate/support": "^5.3",
         "illuminate/database": "^5.3",
-        "illuminate/http": "^5.3"
+        "illuminate/http": "^5.3",
+        "illuminate/console": "^5.3"
     },
     "autoload": {
         "psr-4": {