You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 31, 2022. It is now read-only.
@@ -7,7 +7,7 @@ The **Algolia Search API Client for Android** lets you easily use the [Algolia S
7
7
_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)._
8
8
9
9
10
-
As a complement to this readme, you can browse the automatically generated [reference documentation](https://community.algolia.com/algoliasearch-client-android/).
10
+
You can browse the automatically generated [reference documentation](https://community.algolia.com/algoliasearch-client-android/).
11
11
(See also the [offline-enabled version](https://community.algolia.com/algoliasearch-client-android/offline/).)
12
12
13
13
This project is open-source under the [MIT License](./LICENSE).
@@ -35,11 +35,19 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
35
35
1.**[Quick Start](#quick-start)**
36
36
37
37
*[Initialize the client](#initialize-the-client)
38
-
*[Push data](#push-data)
39
-
*[Search](#search)
40
-
*[Configure](#configure)
41
38
42
-
1.**[Getting Help](#getting-help)**
39
+
1.**[Push data](#push-data)**
40
+
41
+
42
+
1.**[Configure](#configure)**
43
+
44
+
45
+
1.**[Search](#search)**
46
+
47
+
48
+
1.**[Search UI](#search-ui)**
49
+
50
+
*[index.html](#indexhtml)
43
51
44
52
45
53
@@ -49,9 +57,10 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
49
57
50
58
51
59
60
+
52
61
## Install
53
62
54
-
Add the following dependency to your Gradle build file:
63
+
Add the following dependency to your `Gradle` build file:
55
64
56
65
```gradle
57
66
dependencies {
@@ -66,14 +75,19 @@ In 30 seconds, this quick start tutorial will show you how to index and search o
66
75
67
76
### Initialize the client
68
77
69
-
You first need to initialize the client. For that you need your **Application ID** and **API Key**.
70
-
You can find both of them on [your Algolia account](https://www.algolia.com/api-keys).
78
+
To begin, you will need to initialize the client. In order to do this you will need your **Application ID** and **API Key**.
79
+
You can find both on [your Algolia account](https://www.algolia.com/api-keys).
**Warning:** If you are building a native app on mobile, be sure to **not include** the search API key directly in the source code.
87
+
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)
88
+
during the app's startup.
89
+
90
+
## Push data
77
91
78
92
Without any prior configuration, you can start indexing contacts in the ```contacts``` index using the following code:
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:
Settings can be customized to tune the search behavior. For example, you can add a custom sort by number of followers to the already great built-in relevance:
0 commit comments