Skip to content

Commit bafa428

Browse files
Update README [skip ci]
1 parent 3293ba6 commit bafa428

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,16 @@ your Android code.
1010
_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)._
1111

1212

13-
You can browse the automatically generated [reference documentation](https://community.algolia.com/algoliasearch-client-android/).
13+
14+
## Contributing
15+
16+
You can browse the automatically generated [reference documentation](https://community.algolia.com/algoliasearch-client-android/).
1417

1518
This project is open-source under the [MIT License](https://github.com/algolia/algoliasearch-client-android/blob/master/LICENSE).
1619

1720

1821

22+
1923
## Contributing
2024

2125
[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
8185
You can find both on [your Algolia account](https://www.algolia.com/api-keys).
8286

8387
```java
84-
Client client = new Client("YourApplicationID", "YourAPIKey");
88+
Client client = new Client("YourApplicationID", "YourAdminAPIKey");
8589
Index index = client.getIndex("your_index_name");
8690
```
8791

@@ -112,7 +116,7 @@ index.addObjectAsync(new JSONObject()
112116
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:
113117

114118
```java
115-
JSONObject settings = new JSONObject().append("customRanking", "desc(followers)");
119+
JSONObject settings = new JSONObject().put("customRanking", "desc(followers)");
116120
index.setSettingsAsync(settings, null);
117121
```
118122

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

303307

304308

309+
### Vault
310+
311+
312+
313+
314+
305315

306316
## Getting Help
307317

0 commit comments

Comments
 (0)