-
Notifications
You must be signed in to change notification settings - Fork 3
Starter guide for Android SDK #3
base: master
Are you sure you want to change the base?
Starter guide for Android SDK #3
Conversation
AniVerma17
commented
Sep 8, 2023
- Add the quick start guide to document the steps of installing and using the ImageKit Android SDK.
- Update the summary file to add the link of the Android SDK guide.
10485af
to
e3be061
Compare
|
||
#### Installing the SDK | ||
|
||
To Install the SDK, add the following to the root-level `build.gradle`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To Install the SDK, add the following to the root-level `build.gradle`: | |
To install the SDK, add the following to the root-level `build.gradle`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. Please check
|
||
## **Clone and run the tutorial app** | ||
|
||
For this tutorial, it is recommended to use the sample Android app, as shown below. If you already have an existing Android app, it is also possible to use that, which will be explained in the continuation of the sample app. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This statement seems ambiguous. It is a bit unclear. The first part talks about a recommended sample app, but the second part about an existing app and its continuation might confuse readers.
For this tutorial, it is recommended to use the sample Android app, as shown below. If you already have an existing Android app, it is also possible to use that, which will be explained in the continuation of the sample app. | |
For this tutorial, we'll primarily use a sample Android app provided below. If you have your own existing Android app, you can integrate ImageKit into it. Instructions for both scenarios are provided in the subsequent sections. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Modified this paragraph to clear the ambiguity. Please check
// https://ik.imagekit.io/your_imagekit_id/medium_cafe_B1iTdD0C.jpg?tr=oi-logo-white_SJwqB4Nfe.png,ox-10,oy-20 | ||
ImageKit.getInstance() | ||
.url( | ||
src = https://ik.imagekit.io/your_imagekit_id/medium_cafe_B1iTdD0C.jpg", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
src = https://ik.imagekit.io/your_imagekit_id/medium_cafe_B1iTdD0C.jpg", | |
src = "https://ik.imagekit.io/your_imagekit_id/medium_cafe_B1iTdD0C.jpg", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. Please check
publicKey: "your_public_api_key", | ||
urlEndpoint: "your_url_endpoint", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add comments to inform the user to replace these values
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. Please check
b043074
to
33b807b
Compare