Merge branch 'master' into development

Author: sdrrv

README.md

@@ -24,13 +24,15 @@ Follow the standard plugin installation instructions, with a zip version of the
   "rescore": {
     "redis":{
       "key_field": "productId.keyword",
-      "key_prefix": "mystore-",
-      "score_operator": "MULTIPLY"
+      "key_prefixes": ["mystore-","gympass-"],
+      "score_weights": [0.5, 1.0],
+      "score_operator": "ADD",
+      "boost_operator": "ADD",
+      "boost_weight": 1.0
     } 
   } 
 }
 ```
-
 In this example, we are expecting each hit to contain a field `productId` (of keyword type). The value of that field will be looked up in Redis as a key (for example, Redis key `mystore-abc123` will be looked-up for a document with productId abc123; the `mystore-` key prefix is configurable in query time).
 The `score_operator` field is the operator you want to be using when doing your final rescore, you can use `ADD`, `MULTIPLY`, or `SUBTRACT`.
 
@@ -41,7 +43,92 @@ You can use `0` to demote results (e.g. mark as unavailable in stock), `1` to le
 <br/>
 <br/>
 
-# Plugin Builder and Installation
+# Fields and how to use them
+
+<br/>
+
+## --> `key_prefixes` : str[]
+A list that contains the `key_prefixes` to use
+
+<br/>
+
+## --> `score_weights` : float[]
+A list that holds the weight value for each of the key_prefixes in the `key_prefixes` field.    
+For example, in the **Usage** section, the `key_prefix` *"mystore-"* is beeing multiplied by **0.5** and the *"gympass-"* for **1**.
+
+<br/>
+
+## --> `boost_weight` : float
+Holds the weight value of the **elasticsearch_score**.
+For example, if the **elasticsearch_score** is **2** and the `boost_weight` **0.5** then the final **elasticsearch_score** will be **1**. 
+
+<br/>
+
+## --> `score_operator` | `boost_operator` : str
+Can be:
+
+- MULTiPLY
+- ADD
+- SET
+- SUBTRACT
+
+The formula is:
+
+**score** = *elasticsearch_score* (`boost_operator`) ( redis[`key_prefix[0]`+`key_field`] (`score_operator`) redis[`key_prefix[n-1]`+`key_field`])
+
+
+If `score_operator`: *"ADD"* **&** `boost_operator`: *"MULTIPLY"*,   
+The formula will be:
+```
+score = elasticsearch_score * ( redis[mystore-20] + redis[gympass-20])
+```
+
+<br/>
+<br/>
+
+# Field Default Values
+The only field that is **required** for the plugin to run is the `key_field`, all the others can be `null`.
+## Default Values
+### `score_operator` | `boost_operator`
+***"ADD"***
+<br/>
+
+### `scores_weight` | `boost_weight` 
+***1***
+<br/>
+<br/>
+
+# Plugin Installer
+<br/>
+
+## 0- Dowload the plugin
+If you dont have the **.zip** of the compiled plugin you need to download it.  
+You can download it in the [release page](https://github.com/sdrrv/elasticsearch-rescore-redis/releases).
+
+<br/>
+
+## 1- Install the Plugin
+Now you can `cd` into to the `bin` folder in your **ElasticSearch** instalation and run :
+```bash
+$ ./elasticsearch-plugin install file://dirOfYourPlugin
+```
+<br/>
+
+## 2- Change the Redis host
+By default the plugin will think that your **Redis** server is running in the `localhost:6379` , that beeing said, you can change the `Host` but not the `Port`.
+The `Port` will always be `6379` because that's the default `Port` for the **Redis** server to run on. 
+<br/>
+To change the `Host`, you first need to go to the `config` folder in your **ElasticSearch** dir.
+There open the `elasticsearch.yml` file, you want to add the following:
+
+```YAML
+redisRescore.redisUrl : "YourHostIP"
+```
+
+<br/>
+<br/>
+
+# Plugin Builder
 
 ## 1- First pull the git rep into your machine
 <br/>
@@ -106,7 +193,5 @@ The `Port` will always be `6379` because that's the default `Port` for the **Red
 To change the `Host`, you first need to go to the `config` folder in your **ElasticSearch** dir.
 There open the `elasticsearch.yml` file, you want to add the following:
 
-```YAML
-redisRescore.redisUrl : "YourHostIP"
-```
+