Skip to content

Commit 1f19f83

Browse files
authored
Update README.md
1 parent 821f697 commit 1f19f83

File tree

1 file changed

+9
-17
lines changed

1 file changed

+9
-17
lines changed

README.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,14 @@ See the complete list of transformations supported in ImageKit [here](https://do
194194

195195
If you want to generate transformations in your application and add them to the URL as it is, use the `raw` parameter.
196196

197+
<br/>
198+
199+
> #### Deprecation notice
200+
> 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.
201+
> 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.
202+
> `transformation : [{ "width" : 300, "height" : 300 },{ "raw": "l-image,i-logo.png,w-10,rt-90,l-end" }]`
203+
<br/>
204+
197205
| Supported Transformation Name | Translates to parameter |
198206
|-------------------------------|-------------------------|
199207
| height | h |
@@ -255,22 +263,6 @@ If you want to generate transformations in your application and add them to the
255263
| raw | The string provided in raw will be added in the URL as it is. |
256264

257265

258-
##### Deprecation notice
259-
260-
The old overlay syntax 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.
261-
262-
If you are creating overlay transformations using the JavaScript SDK, you can migrate to the new Layers syntax using the raw parameter:
263-
264-
transformation : [
265-
{
266-
"width" : 300,
267-
"height" : 300
268-
},
269-
{
270-
"raw": "l-image,i-logo.png,w-10,rt-90,l-end"
271-
}]
272-
273-
274266
### File Upload
275267

276268
The SDK provides a simple interface using the `.upload()` method to upload files to the ImageKit Media Library.
@@ -423,4 +415,4 @@ try {
423415

424416
// {'content-type': 'application/json', 'x-request-id': 'ee560df4-d44f-455e-a48e-29dfda49aec5'}
425417
console.log(response.$ResponseMetadata.headers);
426-
}
418+
}

0 commit comments

Comments
 (0)