Skip to content

Commit ec89f96

Browse files
imagekitioimagekitio
authored
Update README.md
1 parent 5a6da6e commit ec89f96

1 file changed

Lines changed: 8 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,9 @@
88
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
99
[![Twitter Follow](https://img.shields.io/twitter/follow/imagekitio?label=Follow&style=social)](https://twitter.com/imagekitio)
1010

11-
Android SDK for [ImageKit.io](https://imagekit.io) which implements client-side upload and URL generation for use inside an Android application.
12-
13-
ImageKit is a complete image optimization and transformation solution that comes with an [image CDN](https://imagekit.io/features/imagekit-infrastructure) and media storage. It can be integrated with your existing infrastructure - storages like AWS S3, web servers, your CDN and custom domain names, allowing you to deliver optimized images in minutes with minimal code changes.
14-
15-
ImageKit Android SDK allows you to use real-time [image resizing](https://docs.imagekit.io/features/image-transformations), [optimization](https://docs.imagekit.io/features/image-optimization), and [file uploading](https://docs.imagekit.io/api-reference/upload-file-api/client-side-file-upload) in the client-side.
11+
Android SDK for [ImageKit.io](https://imagekit.io) implements client-side upload and URL generation for use inside an Android application.
1612

13+
ImageKit is a complete media storage, optimization, and transformation solution that comes with an image and video CDN. It can be integrated with your existing infrastructure - storage like AWS S3, web servers, your CDN, and custom domain names, allowing you to deliver optimized images in minutes with minimal code changes.
1714

1815
## Table of contents
1916
* [Installation](#installation)
@@ -63,13 +60,13 @@ implementation 'com.github.imagekit-developer:imagekit-android:<VERSION>'
6360
## Usage
6461

6562
### Initialization
66-
`urlEndpoint` is the required parameter. You can get the value of URL-endpoint from your ImageKit dashboard - https://imagekit.io/dashboard#url-endpoints.
63+
`urlEndpoint` is the required parameter. You can get the value of the URL-endpoint from your ImageKit dashboard - https://imagekit.io/dashboard#url-endpoints.
6764

6865
`transformationPosition` is optional. The default value for this parameter is `TransformationPosition.PATH`. Acceptable values are `TransformationPosition.PATH` & `TransformationPosition.QUERY`.
6966

7067
`defaultUploadPolicy` is optional and only needed if you want to use the SDK for client-side file upload. This sets the default constraints for all the upload requests.
7168

72-
_Note: Do not include your Private Key in any client side code, including this SDK or its initialization._
69+
_Note: Do not include your Private Key in any client-side code, including this SDK or its initialization._
7370

7471
```kotlin
7572
// In kotlin
@@ -302,13 +299,13 @@ ImageKit.Companion.init(
302299
> Note: Do not include your Private Key in any client-side code.
303300
304301
## Constructing Image URLs
305-
The `ImageKitURLConstructor` is used to create a url that can be used for rendering and manipulating images in real-time. `ImageKitURLConstructor` consists of functions that can be chained together to perform transformations.
302+
The `ImageKitURLConstructor` is used to create a url that can be used for rendering and manipulating images in real time. `ImageKitURLConstructor` consists of functions that can be chained together to perform transformations.
306303

307304
`ImageKitURLConstructor` can be initialized by calling `ImageKit.getInstance().url(...)` with a set of parameters defined below.
308305

309306
| Parameter | Type | Description |
310307
|:-----------------------|:-------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
311-
| urlEndpoint | String | Optional. The base URL to be appended before the path of the image. If not specified, the URL-endpoint specified in the parent `IKContext` component is used. For example, https://ik.imagekit.io/your_imagekit_id/endpoint/ |
308+
| urlEndpoint | String | Optional. The base URL to be appended before the path of the image. If not specified, the URL endpoint specified in the parent `IKContext` component is used. For example, https://ik.imagekit.io/your_imagekit_id/endpoint/ |
312309
| path | String | Conditional. This is the path at which the image exists. For example, `/path/to/image.jpg`. Either the `path` or `src` parameter needs to be specified for URL generation. |
313310
| src | String | Conditional. This is the complete URL of an image already mapped to ImageKit. For example, `https://ik.imagekit.io/your_imagekit_id/endpoint/path/to/image.jpg`. Either the `path` or `src` parameter needs to be specified for URL generation. |
314311
| transformationPosition | [TransformationPosition](/imagekit/src/main/java/com/imagekit/android/ImagekitUrlConstructor.kt) | Optional. The default value is `.PATH` that places the transformation string as a URL path parameter. It can also be specified as `.QUERY`, which adds the transformation string as the URL's query parameter i.e.`tr`. If you use `src` parameter to create the URL, then the transformation string is always added as a query parameter. |
@@ -599,7 +596,7 @@ val preprocessor = ImagePreprocessor.Builder()
599596
### Video preprocessing
600597
The `VideoPreprocessor` class encapsulates a set of methods to apply certain transformations to a video before uploading. This will create a copy of the selected video, which will be transformed as per the given parameters before uploading.
601598

602-
`VideoPreprocessor.Builder` class is responsible for building the VideoPreprocess instances. This class provides following methods to access and modify the policy parameters:
599+
`VideoPreprocessor.Builder` class is responsible for building the VideoPreprocess instances. This class provides the following methods to access and modify the policy parameters:
603600

604601
| Parameter | Type | Description |
605602
|:-------------------------------------|:--------------------------|:-----------------------------------------------------|
@@ -760,7 +757,7 @@ IKFrescoExtension.buildWithTarget(
760757
```
761758

762759
## Support
763-
For any feedback or to report any issues or general implementation support please reach out to [support@imagekit.io](mailto:support@imagekit.io)
760+
For any feedback or to report any issues or general implementation support, please reach out to [support@imagekit.io](mailto:support@imagekit.io)
764761

765762
## Links
766763
* [Documentation](https://docs.imagekit.io)

0 commit comments

Comments
 (0)