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

Commit 23b7bbb

Browse files
algoliareadmebotPLNech
authored andcommitted
Update README [skip ci]
1 parent 4084902 commit 23b7bbb

File tree

1 file changed

+25
-16
lines changed

1 file changed

+25
-16
lines changed

README.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Algolia Search API Client for Android
22

3-
[Algolia Search](https://www.algolia.com) is a hosted full-text, numerical,
4-
and faceted search engine capable of delivering realtime results from the first keystroke.
3+
[Algolia Search](https://www.algolia.com) is a hosted search engine capable of delivering realtime results from the first keystroke.
54

65
The **Algolia Search API Client for Android** lets
76
you easily use the [Algolia Search REST API](https://www.algolia.com/doc/rest-api/search) from
@@ -78,23 +77,17 @@ In 30 seconds, this quick start tutorial will show you how to index and search o
7877

7978
### Initialize the client
8079

81-
To begin, you will need to initialize the client. In order to do this you will need your **Application ID** and **API Key**.
80+
To start, you need to initialize the client. To do this, you need your **Application ID** and **API Key**.
8281
You can find both on [your Algolia account](https://www.algolia.com/api-keys).
8382

8483
```java
8584
Client client = new Client("YourApplicationID", "YourAPIKey");
8685
Index index = client.getIndex("your_index_name");
8786
```
8887

89-
**Warning:** If you are building a native app on mobile, be sure to **not include** the search API key directly in the source code.
90-
You should instead consider [fetching the key from your servers](https://www.algolia.com/doc/guides/security/best-security-practices/#api-keys-in-mobile-applications)
91-
during the app's startup.
92-
93-
94-
### Kotlin support
95-
96-
Even though the Android client is written in Java, you can use it in a Kotlin project. Check out our [Android demo (`kotlin` branch)](https://github.com/algolia/algolia-android-demo/tree/kotlin) to see an example.
97-
88+
**Warning:** If you are building a native app on mobile, make sure **not to include the search API key directly in the source code**.
89+
You should instead consider [fetching the key from your servers](https://www.algolia.com/doc/guides/security/security-best-practices/#api-keys-in-mobile-applications)
90+
during the app's startup.
9891

9992
## Push data
10093

@@ -116,7 +109,7 @@ index.addObjectAsync(new JSONObject()
116109

117110
## Configure
118111

119-
Settings can be customized to fine tune the search behavior. For example, you can add a custom sort by number of followers to further enhance the built-in relevance:
112+
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:
120113

121114
```java
122115
JSONObject settings = new JSONObject().append("customRanking", "desc(followers)");
@@ -125,8 +118,8 @@ index.setSettingsAsync(settings, null);
125118

126119
You can also configure the list of attributes you want to index by order of importance (most important first).
127120

128-
**Note:** The Algolia engine is designed to suggest results as you type, which means you'll generally search by prefix.
129-
In this case, the order of attributes is very important to decide which hit is the best:
121+
**Note:** Algolia is designed to suggest results as you type, which means you'll generally search by prefix.
122+
In this case, the order of attributes is crucial to decide which hit is the best.
130123

131124
```java
132125
JSONObject settings = new JSONObject()
@@ -138,7 +131,7 @@ index.setSettingsAsync(settings, null);
138131

139132
## Search
140133

141-
You can now search for contacts using `firstname`, `lastname`, `company`, etc. (even with typos):
134+
You can now search for contacts by `firstname`, `lastname`, `company`, etc. (even with typos):
142135

143136
```java
144137
CompletionHandler completionHandler = new CompletionHandler() {
@@ -168,6 +161,8 @@ index.searchAsync(new Query("jimmie paint"), completionHandler);
168161

169162
### Personalization
170163

164+
- [Add strategy](https://algolia.com/doc/api-reference/api-methods/add-strategy/?language=android)
165+
- [Get strategy](https://algolia.com/doc/api-reference/api-methods/get-strategy/?language=android)
171166

172167

173168

@@ -269,6 +264,20 @@ index.searchAsync(new Query("jimmie paint"), completionHandler);
269264

270265

271266

267+
### Insights
268+
269+
- [Clicked Object IDs After Search](https://algolia.com/doc/api-reference/api-methods/clicked-object-ids-after-search/?language=android)
270+
- [Clicked Object IDs](https://algolia.com/doc/api-reference/api-methods/clicked-object-ids/?language=android)
271+
- [Clicked Filters](https://algolia.com/doc/api-reference/api-methods/clicked-filters/?language=android)
272+
- [Converted Objects IDs After Search](https://algolia.com/doc/api-reference/api-methods/converted-object-ids-after-search/?language=android)
273+
- [Converted Object IDs](https://algolia.com/doc/api-reference/api-methods/converted-object-ids/?language=android)
274+
- [Converted Filters](https://algolia.com/doc/api-reference/api-methods/converted-filters/?language=android)
275+
- [Viewed Object IDs](https://algolia.com/doc/api-reference/api-methods/viewed-object-ids/?language=android)
276+
- [Viewed Filters](https://algolia.com/doc/api-reference/api-methods/viewed-filters/?language=android)
277+
278+
279+
280+
272281
### MultiClusters
273282

274283
- [Assign or Move userID](https://algolia.com/doc/api-reference/api-methods/assign-user-id/?language=android)

0 commit comments

Comments
 (0)