From bafa42829eeea60e50baea7c101c27add47139d7 Mon Sep 17 00:00:00 2001 From: algoliareadmebot Date: Fri, 10 May 2019 11:05:24 +0000 Subject: [PATCH] Update README [skip ci] --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 04bf37d6..1ebc655f 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,16 @@ your Android code. _Note: If you were using **version 2.x** of our Android client, read the [migration guide to version 3.x](https://github.com/algolia/algoliasearch-client-android/wiki/Migration-guide-to-version-3.x)._ -You can browse the automatically generated [reference documentation](https://community.algolia.com/algoliasearch-client-android/). + + ## Contributing + + You can browse the automatically generated [reference documentation](https://community.algolia.com/algoliasearch-client-android/). This project is open-source under the [MIT License](https://github.com/algolia/algoliasearch-client-android/blob/master/LICENSE). + ## Contributing [Your contributions](https://github.com/algolia/algoliasearch-client-android/pull/new) are welcome! Please use our [formatting configuration](https://github.com/algolia/CodingStyle#android) to keep the coding style consistent. @@ -81,7 +85,7 @@ To start, you need to initialize the client. To do this, you need your **Applica You can find both on [your Algolia account](https://www.algolia.com/api-keys). ```java -Client client = new Client("YourApplicationID", "YourAPIKey"); +Client client = new Client("YourApplicationID", "YourAdminAPIKey"); Index index = client.getIndex("your_index_name"); ``` @@ -112,7 +116,7 @@ index.addObjectAsync(new JSONObject() You can customize settings to fine tune the search behavior. For example, you can add a custom ranking by number of followers to further enhance the built-in relevance: ```java -JSONObject settings = new JSONObject().append("customRanking", "desc(followers)"); +JSONObject settings = new JSONObject().put("customRanking", "desc(followers)"); index.setSettingsAsync(settings, null); ``` @@ -302,6 +306,12 @@ index.searchAsync(new Query("jimmie paint"), completionHandler); +### Vault + + + + + ## Getting Help