Skip to content
This repository has been archived by the owner on Jan 31, 2022. It is now read-only.

Commit

Permalink
Update README [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
algoliareadmebot committed May 10, 2019
1 parent 3293ba6 commit 7f00a67
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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");
```

Expand Down Expand Up @@ -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);
```

Expand Down Expand Up @@ -302,6 +306,12 @@ index.searchAsync(new Query("jimmie paint"), completionHandler);



### Vault






## Getting Help

Expand Down

0 comments on commit 7f00a67

Please sign in to comment.