From 0a5582a323eca0d8ebf3be780a5d6a0247349ae8 Mon Sep 17 00:00:00 2001
From: Alessio Gogna <5177307+alecsg77@users.noreply.github.com>
Date: Sat, 8 May 2021 23:22:21 +0200
Subject: [PATCH] [enhancement] Filter Indexers documentation (#11697)

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.md b/README.md
index f07c7bcf5..7133a3e69 100644
--- a/README.md
+++ b/README.md
@@ -584,6 +584,27 @@ Using the all indexer has no advantages (besides reduced management overhead), o
 
 To get all Jackett indexers including their capabilities you can use `t=indexers` on the all indexer. To get only configured/unconfigured indexers you can also add `configured=true/false` as a query parameter.
 
+### Filter indexers
+
+Another special "filter" indexer is avaible at <code>/api/v2.0/indexers/<i><b>filter</b></i>/results/torznab</code>
+It will query the configured indexers that match the <i><b>filter</b></i> expression criterias and return the combined results as "all".
+
+Supported filters
+Filter | Condition
+-|-
+<code>type:<i><b>type</b></i></code> | where the indexer type is equal to <i><b>type</b></i>
+<code>tag:<i><b>tag</b></i></code> | where the indexer tags contains <i><b>tag</b></i>
+<code>lang:<i><b>tag</b></i></code> | where the indexer language start with <i><b>lang</b></i>
+
+Supported operators
+Operator | Condition
+-|-
+<code>!<i><b>filter</b></i></code> | where not <i><b>filter</b></i>
+<code><i><b>filter1</b></i>+<i><b>filter2</b></i>+...</code> | where <i><b>filter1</b></i> and <i><b>filter2</b> and ...</
+<code><i><b>filter1</b></i>,<i><b>filter2</b></i>,...</code> | where <i><b>filter1</b></i> or <i><b>filter2</b> or ...</
+
+Example:
+The "filter" indexer at <code>/api/v2.0/indexers/<b>tag:group1,!type:private+lang:en</b>/results/torznab</code> will query all the configured indexers tagged with `group1` or all the indexers not private and with `en` language (`en-en`,`en-us`,...)
 
 ## Installation on Windows
 We recommend you install Jackett as a Windows service using the supplied installer. You may also download the zipped version if you would like to configure everything manually.