diff --git a/README.md b/README.md index 34ff728..cfda9db 100644 --- a/README.md +++ b/README.md @@ -199,6 +199,14 @@ See the complete list of transformations supported in ImageKit [here](https://do If you want to generate transformations in your application and add them to the URL as it is, use the `raw` parameter. +
+ +> #### Deprecation notice +> The list below mentions the old overlay syntax parameters such as `oi`, `ot`, `obg`, and more. These parameters will be deprecated on 31st Oct 2023 and will start returning errors when used in URLs. Please migrate to the new Layers syntax that supports overlay nesting, provides better positional control, and allows more transformations at the layer level. You can start with [examples](https://docs.imagekit.io/features/image-transformations/overlay-using-layers#examples) to learn quickly. +> If you create overlay transformations using the JavaScript SDK, you can migrate to the new Layers syntax using the `raw` transformation parameter, as given in the example below. +> `transformation : [{ "width" : 300, "height" : 300 },{ "raw": "l-image,i-logo.png,w-10,rt-90,l-end" }]` +
+ | Supported Transformation Name | Translates to parameter | |-------------------------------|-------------------------| | height | h | @@ -425,4 +433,4 @@ try { // {'content-type': 'application/json', 'x-request-id': 'ee560df4-d44f-455e-a48e-29dfda49aec5'} console.log(response.$ResponseMetadata.headers); } -``` +``` \ No newline at end of file