Merge pull request #101 from algoliareadmebot/master

Update README

Author: maxiloc

README.md

@@ -357,7 +357,7 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
 - [numericFilters (deprecated)](#numericfilters-deprecated) `search`
 - [tagFilters (deprecated)](#tagfilters-deprecated) `search`
 - [facetFilters (deprecated)](#facetfilters-deprecated) `search`
-- [analytics](#analytics) `settings`, `search`
+- [analytics](#analytics) `search`
 
 <!--/PARAMETERS_LINK-->
 
@@ -694,7 +694,7 @@ Parameters that can be override at search time also have the `indexing` [scope](
 - [optionalWords](#optionalwords) `settings`, `search`
 - [removeStopWords](#removestopwords) `settings`, `search`
 - [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
-- [disableExactOnAttributes](#disableexactonattributes) `settings`
+- [disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
 - [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
 - [alternativesAsExact](#alternativesasexact) `settings`, `search`
 
@@ -752,6 +752,7 @@ They are three scopes:
 - [highlightPreTag](#highlightpretag) `settings`, `search`
 - [highlightPostTag](#highlightposttag) `settings`, `search`
 - [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
+- [restrictHighlightAndSnippetArrays](#restricthighlightandsnippetarrays) `settings`, `search`
 
 **Pagination**
 - [page](#page) `search`
@@ -781,7 +782,7 @@ They are three scopes:
 - [optionalWords](#optionalwords) `settings`, `search`
 - [removeStopWords](#removestopwords) `settings`, `search`
 - [disablePrefixOnAttributes](#disableprefixonattributes) `settings`
-- [disableExactOnAttributes](#disableexactonattributes) `settings`
+- [disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
 - [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
 - [alternativesAsExact](#alternativesasexact) `settings`, `search`
 
@@ -794,7 +795,7 @@ They are three scopes:
 - [numericFilters (deprecated)](#numericfilters-deprecated) `search`
 - [tagFilters (deprecated)](#tagfilters-deprecated) `search`
 - [facetFilters (deprecated)](#facetfilters-deprecated) `search`
-- [analytics](#analytics) `settings`, `search`
+- [analytics](#analytics) `search`
 - [altCorrections](#altcorrections) `settings`
 - [placeholders](#placeholders) `settings`
 
@@ -1002,20 +1003,32 @@ The list of keywords is:
 - default: `""`
 
 
-List of object attributes that you want to use for faceting.
+You can use [facets](#facets) to retrieve only a part of your attributes declared in
+**[attributesForFaceting](#attributesforfaceting)** attributes.
+It will not filter your results, if you want to filter results you should use [filters](#filters).
 
 For each of the declared attributes, you'll be able to retrieve a list of the most relevant facet values,
 and their associated count for the current query.
 
-Attributes are separated by a comma.
+** Example **
 
-For example, `"category,author"`.
+If you have defined in your **[attributesForFaceting](#attributesforfaceting)**:
+
+['category', 'author', 'nb_views', 'nb_downloads']
+
+But for the current search want to retrieve only facet values for `category` and `author`.
+
+You can specify your attributes coma separated.
+
+For this example:  `"category,author"`.
 
 You can also use JSON string array encoding.
 
-For example, `["category","author"]`.
+For this example: `["category","author"]`.
+
+**Warnings**
 
-Only the attributes that have been added in **attributesForFaceting** index setting can be used in this parameter.
+- When using [facets](#facets) in a search query, only attributes that have been added in **attributesForFaceting** index setting can be used in this parameter.
 You can also use `*` to perform faceting on all attributes specified in `attributesForFaceting`.
 If the number of results is important, the count can be approximate,
 the attribute `exhaustiveFacetsCount` in the response is true when the count is exact.
@@ -1097,6 +1110,15 @@ Specify the string that is inserted after the highlighted parts in the query res
 String used as an ellipsis indicator when a snippet is truncated.
 Defaults to an empty string for all accounts created before 10/2/2016, and to … (UTF-8 U+2026) for accounts created after that date.
 
+#### restrictHighlightAndSnippetArrays
+
+- scope: `settings`, `search`
+- type: `boolean`
+- default: `false`
+
+
+If set to true, restrict arrays in highlights and snippets to items that matched the query at least partially else return all array items in highlights and snippets.
+
 ### Pagination
 
 #### page
@@ -1408,7 +1430,7 @@ This setting is useful on attributes that contain string that should not be matc
 
 #### disableExactOnAttributes
 
-- scope: `settings`
+- scope: `settings`, `search`
 - type: `array of strings`
 - default: `[]`
 
@@ -1528,6 +1550,8 @@ When enabled, the integer array is reordered to reach a better compression ratio
 - default: `[]`
 
 
+*This parameter is deprecated. Please use [filters](#filters) instead.*
+
 A string that contains the comma separated list of numeric filters you want to apply.
 The filter syntax is `attributeName` followed by `operand` followed by `value`.
 Supported operands are `<`, `<=`, `=`, `>` and `>=`.
@@ -1552,6 +1576,8 @@ You can also use a string array encoding (for example `numericFilters: ["price>1
 - default: `""`
 
 
+*This parameter is deprecated. Please use [filters](#filters) instead.*
+
 Filter the query by a set of tags.
 
 You can AND tags by separating them with commas.
@@ -1578,6 +1604,8 @@ For example `{"_tags":["tag1","tag2"]}`.
 - default: `""`
 
 
+*This parameter is deprecated. Please use [filters](#filters) instead.*
+
 Filter the query with a list of facets. Facets are separated by commas and is encoded as `attributeName:value`.
 To OR facets, you must add parentheses.
 
@@ -1589,9 +1617,9 @@ For example, `[["category:Book","category:Movie"],"author:John%20Doe"]`.
 
 #### analytics
 
-- scope: `settings`, `search`
-- type: `string`
-- default: `['ignorePlurals', 'singleWordSynonym']`
+- scope: `search`
+- type: `boolean`
+- default: `true`
 
 
 If set to false, this query will not be taken into account in the analytics feature.