docs(README): automatic update

  Update README Android
  [This list might not be relevant]
  Add a warning informing about the maxValuesPerFacet hard limit of 1000 (#125)

Merge branch 'master' of github.com:algolia/algoliasearch-client-readme-generator

improve api keys section

iteration on api keys

Fix some typos

iteration on api keys

iteration on api keys

Add TOC for recently added geo search parameters
Add missing `aroundRadius`, `aroundPrecision` and `minimumAroundRadius` search parameters
Reformatting and rephrasing
Ensure code blocks and lists are separated by a blank line

Some Markdown processors (such as that used by Jazzy) are very picky about that. If a list or a code block is not separated from the previous paragraph by a blank line, it gets treated as a continuation of the paragraph, resulting in the loss of formatting.
fix case sensitive issue

Add parameter `minProximity`
Add parameter `replaceSynonymsInHighlight`
Add search parameter `synonyms`
Add parameter `analyticsTags`
Fix search parameter TOCs

I added a small shell script to compute a draft of the TOC from the file’s contents. [ci skip]

Author: algoliareadmebot

README.md

@@ -332,11 +332,11 @@ The server response will look like:
 
 - `nbHits` (integer): Number of hits that the search query matched.
 
-- `page` (integer): Index of the current page (zero-based). See the [`page`](#page) search parameter.
+- `page` (integer): Index of the current page (zero-based). See the [`page`](#page) search parameter. *Note: Not returned if you use `offset`/`length` for pagination.*
 
-- `hitsPerPage` (integer): Maximum number of hits returned per page. See the [`hitsPerPage`](#hitsperpage) search parameter.
+- `hitsPerPage` (integer): Maximum number of hits returned per page. See the [`hitsPerPage`](#hitsperpage) search parameter. *Note: Not returned if you use `offset`/`length` for pagination.*
 
-- `nbPages` (integer): Number of pages corresponding to the number of hits. Basically, `ceil(nbHits / hitsPerPage)`.
+- `nbPages` (integer): Number of pages corresponding to the number of hits. Basically, `ceil(nbHits / hitsPerPage)`. *Note: Not returned if you use `offset`/`length` for pagination.*
 
 - `processingTimeMS` (integer): Time that the server took to process the request, in milliseconds. *Note: This does not include network time.*
 
@@ -356,7 +356,7 @@ When [`getRankingInfo`](#getrankinginfo) is set to `true`, the following additio
 
 - `serverUsed` (string): Actual host name of the server that processed the request. (Our DNS supports automatic failover and load balancing, so this may differ from the host name used in the request.)
 
-- `parsedQuery` (string): The query string that will be searched, after normalization.
+- `parsedQuery` (string): The query string that will be searched, after normalization. Normalization includes removing stop words (if [removeStopWords](#removestopwords) is enabled), and transforming portions of the query string into phrase queries (see [advancedSyntax](#advancedsyntax)).
 
 - `timeoutCounts` (boolean): Whether a timeout was hit when computing the facet counts. When `true`, the counts will be interpolated (i.e. approximate). See also `exhaustiveFacetsCount`.
 
@@ -400,6 +400,7 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
 **Attributes**
 
 - [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
+- [restrictSearchableAttributes](#restrictsearchableattributes) `search`
 
 **Filtering / Faceting**
 
@@ -414,11 +415,14 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
 - [highlightPreTag](#highlightpretag) `settings`, `search`
 - [highlightPostTag](#highlightposttag) `settings`, `search`
 - [snippetEllipsisText](#snippetellipsistext) `settings`, `search`
+- [restrictHighlightAndSnippetArrays](#restricthighlightandsnippetarrays) `settings`, `search`
 
 **Pagination**
 
 - [page](#page) `search`
 - [hitsPerPage](#hitsperpage) `settings`, `search`
+- [offset](#offset) `search`
+- [length](#length) `search`
 
 **Typos**
 
@@ -446,6 +450,7 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
 - [advancedSyntax](#advancedsyntax) `settings`, `search`
 - [optionalWords](#optionalwords) `settings`, `search`
 - [removeStopWords](#removestopwords) `settings`, `search`
+- [disableExactOnAttributes](#disableexactonattributes) `settings`, `search`
 - [exactOnSingleWordQuery](#exactonsinglewordquery) `settings`, `search`
 - [alternativesAsExact](#alternativesasexact) `settings`, `search`
 
@@ -457,9 +462,55 @@ Parameters that can also be used in a setSettings also have the `indexing` [scop
 - [tagFilters (deprecated)](#tagfilters-deprecated) `search`
 - [facetFilters (deprecated)](#facetfilters-deprecated) `search`
 - [analytics](#analytics) `search`
+- [analyticsTags](#analyticstags) `search`
+- [synonyms](#synonyms) `search`
+- [replaceSynonymsInHighlight](#replacesynonymsinhighlight) `search`, `settings`
+- [minProximity](#minproximity) `search`, `settings`
 
 <!--/PARAMETERS_LINK-->
 
+### Multiple queries - `multipleQueriesAsync`
+
+You can send multiple queries with a single API call using a batch of queries:
+
+```java
+// perform 3 queries in a single API call:
+//  - 1st query targets index `categories`
+//  - 2nd and 3rd queries target index `products`
+
+List<IndexQuery> queries = new ArrayList<>();
+
+queries.add(new IndexQuery("categories", new Query(myQueryString).setHitsPerPage(3)));
+queries.add(new IndexQuery("products", new Query(myQueryString).setHitsPerPage(3).set("filters", "_tags:promotion"));
+queries.add(new IndexQuery("products", new Query(myQueryString).setHitsPerPage(10)));
+
+client.multipleQueriesAsync(queries, new CompletionHandler() {
+    @Override
+    public void requestCompleted(JSONObject content, AlgoliaException error) {
+        // [...]
+    }
+});
+```
+
+You can specify a `strategy` parameter to optimize your multiple queries:
+
+- `none`: Execute the sequence of queries until the end.
+- `stopIfEnoughMatches`: Execute the sequence of queries until the number of hits is reached by the sum of hits.
+
+#### Response
+
+The resulting JSON contains the following fields:
+
+- `results` (array): The results for each request, in the order they were submitted. The contents are the same as in [Search in an index](#search-in-an-index---searchasync).
+
+    Each result also includes the following additional fields:
+
+    - `index` (string): The name of the targeted index.
+
+    - `processed` (boolean, optional): *Note: Only returned when `strategy` is `stopIfEnoughmatches`.* Whether the query was processed.
+
+
+
 ### Find by IDs - `getObjectsAsync`
 
 You can easily retrieve an object using its `objectID` and optionally specify a comma separated list of attributes you want:
@@ -831,11 +882,11 @@ They are three scopes:
 
 **Attributes**
 
-- [attributesForFaceting](#attributesforfaceting) `settings`
 - [attributesToIndex](#attributestoindex) `settings`
-- [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
+- [attributesForFaceting](#attributesforfaceting) `settings`
 - [unretrievableAttributes](#unretrievableattributes) `settings`
-
+- [attributesToRetrieve](#attributestoretrieve) `settings`, `search`
+- [restrictSearchableAttributes](#restrictsearchableattributes) `search`
 
 **Ranking**
 
@@ -862,6 +913,8 @@ They are three scopes:
 
 - [page](#page) `search`
 - [hitsPerPage](#hitsperpage) `settings`, `search`
+- [offset](#offset) `search`
+- [length](#length) `search`
 
 **Typos**
 
@@ -906,8 +959,12 @@ They are three scopes:
 - [tagFilters (deprecated)](#tagfilters-deprecated) `search`
 - [facetFilters (deprecated)](#facetfilters-deprecated) `search`
 - [analytics](#analytics) `search`
-- [altCorrections](#altcorrections) `settings`
+- [analyticsTags](#analyticstags) `search`
+- [synonyms](#synonyms) `search`
+- [replaceSynonymsInHighlight](#replacesynonymsinhighlight) `search`, `settings`
 - [placeholders](#placeholders) `settings`
+- [altCorrections](#altcorrections) `settings`
+- [minProximity](#minproximity) `search`, `settings`
 
 ### Search
 
@@ -1148,6 +1205,10 @@ Limit the number of facet values returned for each facet.
 
 For example, `maxValuesPerFacet=10` will retrieve a maximum of 10 values per facet.
 
+**Warnings**
+
+- The engine has a hard limit on the `maxValuesPerFacet` of `1000`. Any value above that will be interpreted by the engine as being `1000`.
+
 ### Highlighting / Snippeting
 
 #### attributesToHighlight
@@ -1247,6 +1308,28 @@ Pagination parameter used to select the page to retrieve.
 
 Pagination parameter used to select the number of hits per page.
 
+#### offset
+
+- scope: `search`
+- type: `integer`
+- default: `null`
+
+
+Offset of the first hit to return (zero-based).
+
+**Warning:** In most cases, `page`/`hitsPerPage` is the recommended method for pagination; `offset`/`length` is reserved for advanced use.
+
+#### length
+
+- scope: `search`
+- type: `integer`
+- default: `null`
+
+
+Number of hits to return.
+
+**Warning:** In most cases, `page`/`hitsPerPage` is the recommended method for pagination; `offset`/`length` is reserved for advanced use.
+
 ### Typos
 
 #### minWordSizefor1Typo
@@ -1770,6 +1853,33 @@ For example, `[["category:Book","category:Movie"],"author:John%20Doe"]`.
 
 If set to false, this query will not be taken into account in the analytics feature.
 
+#### analyticsTags
+
+- scope: `search`
+- type: `array of strings`
+- default: `null`
+
+
+If set, tag your query with the specified identifiers. Tags can then be used in the Analytics to analyze a subset of searches only.
+
+#### synonyms
+
+- scope: `search`
+- type: `boolean`
+- default: `true`
+
+
+If set to `false`, the search will not use the synonyms defined for the targeted index.
+
+#### replaceSynonymsInHighlight
+
+- scope: `search`, `settings`
+- type: `boolean`
+- default: `true`
+
+
+If set to `false`, words matched via synonym expansion will not be replaced by the matched synonym in the highlighted result.
+
 #### placeholders
 
 - scope: `settings`
@@ -1817,6 +1927,19 @@ For example:
 ]
 ```
 
+#### minProximity
+
+- scope: `search`, `settings`
+- type: `integer`
+- default: `1`
+
+
+Configure the precision of the `proximity` ranking criterion. By default, the minimum (and best) proximity value distance between 2 matching words is 1. Setting it to 2 (or 3) would allow 1 (or 2) words to be found between the matching words without degrading the proximity ranking value.
+
+Considering the query *“javascript framework”*, if you set `minProximity=2`, the records *“JavaScript framework”* and *“JavaScript charting framework”* will get the same proximity score, even if the second contains a word between the two matching words.
+
+**Note:** the maximum `minProximity` that can be set is 7. Any higher value will disable the `proximity` criterion from the ranking formula.
+
 
 ## Manage Indices
 
@@ -2028,47 +2151,6 @@ iterator.start();
 ```
 
 
-### Multiple queries - `multipleQueriesAsync`
-
-You can send multiple queries with a single API call using a batch of queries:
-
-```java
-// perform 3 queries in a single API call:
-//  - 1st query targets index `categories`
-//  - 2nd and 3rd queries target index `products`
-
-List<IndexQuery> queries = new ArrayList<>();
-
-queries.add(new IndexQuery("categories", new Query(myQueryString).setHitsPerPage(3)));
-queries.add(new IndexQuery("products", new Query(myQueryString).setHitsPerPage(3).set("filters", "_tags:promotion"));
-queries.add(new IndexQuery("products", new Query(myQueryString).setHitsPerPage(10)));
-
-client.multipleQueriesAsync(queries, new CompletionHandler() {
-    @Override
-    public void requestCompleted(JSONObject content, AlgoliaException error) {
-        // [...]
-    }
-});
-```
-
-You can specify a `strategy` parameter to optimize your multiple queries:
-
-- `none`: Execute the sequence of queries until the end.
-- `stopIfEnoughMatches`: Execute the sequence of queries until the number of hits is reached by the sum of hits.
-
-#### Response
-
-The resulting JSON contains the following fields:
-
-- `results` (array): The results for each request, in the order they were submitted. The contents are the same as in [Search in an index](#search-in-an-index---searchasync).
-
-    Each result also includes the following additional fields:
-
-    - `index` (string): The name of the targeted index.
-
-    - `processed` (boolean, optional): *Note: Only returned when `strategy` is `stopIfEnoughmatches`.* Whether the query was processed.
-
-
 
 ### REST API