From b9266f3014a8bbdd929aeb877e2d9902a0f9f703 Mon Sep 17 00:00:00 2001
From: Ryan DJ <ryan.djoenaidi@wundermanthompson.com>
Date: Fri, 14 Aug 2020 16:02:01 +1200
Subject: [PATCH] add docs

---
 readme.md               | 17 ++++++++++++++++-
 src/FilterExtension.php |  2 +-
 2 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/readme.md b/readme.md
index 38d3729..8657f26 100644
--- a/readme.md
+++ b/readme.md
@@ -14,8 +14,23 @@ Custom filters collection for Silverstripe Model Admin GridField.
     extensions:
         - Heyday\ModelAdminFilter\FilterExtension
     ```
-
 - In your model admin, add this function:
+    ```
+    /**
+     * {@inheritdoc}
+     */
+    public function getList()
+    {
+        $list = parent::getList();
+        $list = $this->getFilteredList($list);
+
+        return $list;
+    }
+    ```
+    
+`getFilteredList` will return filtered list from custom filter.
+
+- Also in your model admin, add this function to add custom filter fields:
     ```
     /**
      * List of ModelAdminFilter custom fields
diff --git a/src/FilterExtension.php b/src/FilterExtension.php
index 5969373..9b520a6 100644
--- a/src/FilterExtension.php
+++ b/src/FilterExtension.php
@@ -92,7 +92,7 @@ public function getFilterParams(): array
     /**
      * Update model admin list based on param
      */
-    public function updateList(DataList $list)
+    public function getFilteredList(DataList $list)
     {
         // get search params
         $params = $this->getFilterParams();