Skip to content

Commit 4228897

Browse files
authored
Update README.md
1 parent 0799ba8 commit 4228897

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,25 @@
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-
ImageKit React SDK allows you to resize, optimize, deliver and upload images and videos in your react application.
11+
ImageKit React SDK allows you to resize, optimize, deliver, and upload images and videos in your React application.
1212

1313
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.
1414

1515
## Changelog - SDK Version 3.0.0
1616
### Breaking changes
1717
**1. Authentication Process Update:**
18-
* Previously, when using this SDK, we had to pass `authenticationEndpoint` which is used by SDK internally for fetching security parameters i.e `signature`, `token`, and `expire`.
1918
* In version 3.0.0, we have deprecated the use of the `authenticationEndpoint` parameter. Instead, the SDK now introduces a new parameter named `authenticator`. This parameter expects an asynchronous function that resolves with an object containing the necessary security parameters i.e `signature`, `token`, and `expire`.
20-
* Now `ref` needs to passed instead of `inputRef` in IKUpload component
19+
* Now `ref` needs to be passed instead of `inputRef` in the IKUpload component
2120

22-
Example implementation for `authenticator` using `Fetch API`.
21+
An example implementation for `authenticator` using `Fetch API`.
2322

2423
``` javascript
2524

2625
const authenticator = async () => {
2726
try {
2827

29-
// You can pass headers as well and later validate the request source in the backend, or you can use headers for any other use case.
28+
// You can also pass headers and validate the request source in the backend, or you can use headers for any other use case.
3029
const headers = {
31-
'Authorization': 'Bearer your-access-token',
3230
'CustomHeader': 'CustomValue'
3331
};
3432

@@ -135,7 +133,7 @@ import { IKImage, IKVideo, IKContext, IKUpload } from 'imagekitio-react'
135133
lqip={{ active: true, quality: 20, blur: 10 }}
136134
/>
137135

138-
// Low-quality image placeholder and lazy loading original image in the background
136+
// Low-quality image placeholder and lazy loading of original image in the background
139137
<IKImage
140138
path="/default-image.jpg"
141139
transformation={[{

0 commit comments

Comments
 (0)