Skip to content
This repository has been archived by the owner on Sep 26, 2023. It is now read-only.

Starter guide for Android SDK #3

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

AniVerma17
Copy link

  • 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.

@AniVerma17 AniVerma17 marked this pull request as ready for review September 11, 2023 09:21
@AniVerma17 AniVerma17 force-pushed the chore/android_quickstart_guide branch from 10485af to e3be061 Compare September 11, 2023 09:30

#### Installing the SDK

To Install the SDK, add the following to the root-level `build.gradle`:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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`:

Copy link
Author

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.
Copy link
Member

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.

Suggested change
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.

Copy link
Author

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",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
src = https://ik.imagekit.io/your_imagekit_id/medium_cafe_B1iTdD0C.jpg",
src = "https://ik.imagekit.io/your_imagekit_id/medium_cafe_B1iTdD0C.jpg",

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Please check

Comment on lines 244 to 245
publicKey: "your_public_api_key",
urlEndpoint: "your_url_endpoint",
Copy link
Member

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

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Please check

@AniVerma17 AniVerma17 force-pushed the chore/android_quickstart_guide branch from b043074 to 33b807b Compare January 22, 2024 13:18
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants