Updated Readme autogeneration

Author: Nick-S-2018

LICENSE.txt

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -1,19 +1,20 @@
 # manticoresearch
 
+
 Low-level client for Manticore Search.
 
 
-  For more information, please visit [https://manticoresearch.com/contact-us/](https://manticoresearch.com/contact-us/)
+❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-java/tree/2.0.3
 
 
 ## Requirements
 
 Building the API client library requires:
 
-1. Java 1.7+
+1. Java 1.8+
 2. Maven/Gradle
 
-Minimum Manticore Search version is  > 4.0.2 with HTTP protocol enabled.
+Minimum Manticore Search version is 2.5.1 with HTTP protocol enabled.
 
 ## Installation
 
@@ -23,7 +24,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>com.manticoresearch</groupId>
   <artifactId>manticoresearch</artifactId>
-  <version>3.0.0</version>
+  <version>3.1.0</version>
 </dependency>
 ```
 
@@ -32,7 +33,7 @@ Add this dependency to your project's POM:
 Add this dependency to your project's build file:
 
 ```groovy
-compile "com.manticoresearch:manticoresearch:3.0.0"
+compile "com.manticoresearch:manticoresearch:3.1.0"
 ```
 
 ### Others
@@ -45,7 +46,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-- `target/manticoresearch-3.0.0.jar`
+- `target/manticoresearch-3.1.0.jar`
 - `target/lib/*.jar`
 
 ## Getting Started
@@ -54,30 +55,24 @@ Please follow the [installation](#installation) instruction and execute the foll
 
 ```java
 
-import com.manticoresearch.client.ApiClient;
-import com.manticoresearch.client.ApiException;
-import com.manticoresearch.client.Configuration;
+import com.manticoresearch.client.*;
+import com.manticoresearch.client.auth.*;
 import com.manticoresearch.client.model.*;
 import com.manticoresearch.client.api.IndexApi;
-import com.manticoresearch.client.api.UtilsApi;
-import com.manticoresearch.client.api.SearchApi;
 
-public class SearchApiExample {
+public class IndexApiExample {
 
     public static void main(String[] args) {
-        ApiClient client = Configuration.getDefaultApiClient();
-        client.setBasePath("http://127.0.0.1:9308");
-        SearchApi searchApi = new SearchApi(client);
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        defaultClient.setBasePath("http://127.0.0.1:9308");
+        
+        IndexApi apiInstance = new IndexApi(defaultClient);
+        String body = ["'{\"insert\": {\"index\": \"test\", \"id\": 1, \"doc\": {\"title\": \"Title 1\"}}},\\n{\"insert\": {\"index\": \"test\", \"id\": 2, \"doc\": {\"title\": \"Title 2\"}}}'"]; // String | 
         try {
-            HashMap<String,Object> query = new HashMap<String,Object>();
-            query.put("query_string","@title way* @content hey");
-            searchRequest = new SearchRequest();
-            searchRequest.setIndex("forum");
-            searchRequest.setQuery(query);
-            SearchResponse searchResponse =  searchApi.search(searchRequest);
-            System.out.println(searchResponse);
+            BulkResponse result = apiInstance.bulk(body);
+            System.out.println(result);
         } catch (ApiException e) {
-            System.err.println("Exception when calling SearchApi#search");
+            System.err.println("Exception when calling IndexApi#bulk");
             System.err.println("Status code: " + e.getCode());
             System.err.println("Reason: " + e.getResponseBody());
             System.err.println("Response headers: " + e.getResponseHeaders());
@@ -118,6 +113,7 @@ Class | Method | HTTP request | Description
  - [ErrorResponse](docs/ErrorResponse.md)
  - [InsertDocumentRequest](docs/InsertDocumentRequest.md)
  - [PercolateRequest](docs/PercolateRequest.md)
+ - [PercolateRequestQuery](docs/PercolateRequestQuery.md)
  - [SearchRequest](docs/SearchRequest.md)
  - [SearchResponse](docs/SearchResponse.md)
  - [SearchResponseHits](docs/SearchResponseHits.md)
@@ -126,6 +122,15 @@ Class | Method | HTTP request | Description
  - [UpdateResponse](docs/UpdateResponse.md)
 
 
+## Documentation for Authorization
+
+All endpoints do not require authorization.
+Authentication schemes defined for the API:
+
+## Recommendation
+
+It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
+
 ## Author
 
 [email protected]