diff --git a/README.md b/README.md index f356415..d00024f 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,12 @@ ImageKit is a complete media storage, optimization, and transformation solution ## Breaking changes +### Upgrading from 4.x to 5.x version + +1. `IKContext` has been removed. + +* In version 5.0.0, we have replaced `IKContext` with [`ImageKitProvider`](#ImageKitProvider) and introduced a new component called [`ImageKitContext`](#ImageKitContext). + ### Upgrading from 3.x to 4.x version 1. Overlay syntax update @@ -81,18 +87,18 @@ yarn add imagekitio-react Import components in your code: ```js -import { IKImage, IKVideo, IKContext, IKUpload } from 'imagekitio-react' +import { IKImage, IKVideo, ImageKitProvider, IKUpload, ImageKitContext } from 'imagekitio-react' ``` ### Quick examples #### Image & video rendering and transformations ```js - + // Render an image using a relative path - https://ik.imagekit.io/your_imagekit_id/default-image.jpg - // Overriding urlEndpoint defined in parent IkContext - https://www.custom-domain.com/default-image.jpg + // Overriding urlEndpoint defined in parent ImageKitProvider - https://www.custom-domain.com/default-image.jpg // Render an image using an absolute URL - https://www1.custom-domain.com/default-image.jpg?tr=w-100 @@ -119,12 +125,12 @@ import { IKImage, IKVideo, IKContext, IKUpload } from 'imagekitio-react' transformation={[{ height: 200, width: 200, q: 50 }]} controls={true} /> - + ``` #### Image lazy loading and low-quality placeholder ```js - + // Lazy loading image - + ``` #### File upload example ```js -// Ensure you pass publicKey, urlEndpoint, and authenticator function to the parent IKContext component or to the IKUpload component directly. -Promise} @@ -207,7 +213,7 @@ import { IKImage, IKVideo, IKContext, IKUpload } from 'imagekitio-react' }} checks={`"file.size" < "1mb"`} // To run server side checks before uploading files. Notice the quotes around file.size and 1mb. /> - + ``` ## Demo application @@ -216,26 +222,27 @@ import { IKImage, IKVideo, IKContext, IKUpload } from 'imagekitio-react' ## Components -The library includes 5 Components: +The library includes 6 Components: -* [`IKContext`](#IKContext) for defining options like `urlEndpoint`, `publicKey` or `authenticator` to all children elements. This component does not render anything. +* [`ImageKitProvider`](#ImageKitProvider) for defining options like `urlEndpoint`, `publicKey` or `authenticator` to all children elements. This component does not render anything. * `IKImage` for [image resizing](#image-resizing). This renders a `` tag. * `IKVideo` for [video resizing](#video-resizing). This renders a `