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

Update README [skip ci] #577

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README [skip ci] #577

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
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