From 821f697b99be44d0a54aa3133aef6baab5e3ddd3 Mon Sep 17 00:00:00 2001
From: ashishleo10 <116792966+ashishleo10@users.noreply.github.com>
Date: Tue, 5 Sep 2023 13:44:03 +0530
Subject: [PATCH 1/2] Layered Syntax Notification
---
README.md | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/README.md b/README.md
index ebe0205..380e3b7 100644
--- a/README.md
+++ b/README.md
@@ -255,6 +255,22 @@ If you want to generate transformations in your application and add them to the
| raw | The string provided in raw will be added in the URL as it is. |
+##### Deprecation notice
+
+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.
+
+If you are creating overlay transformations using the JavaScript SDK, you can migrate to the new Layers syntax using the raw parameter:
+
+transformation : [
+{
+ "width" : 300,
+ "height" : 300
+},
+{
+ "raw": "l-image,i-logo.png,w-10,rt-90,l-end"
+ }]
+
+
### File Upload
The SDK provides a simple interface using the `.upload()` method to upload files to the ImageKit Media Library.
From 1f19f837edbb03aeb06b38e65675912e2389bd83 Mon Sep 17 00:00:00 2001
From: "ImageKit.io" <45416977+imagekitio@users.noreply.github.com>
Date: Thu, 7 Sep 2023 12:33:30 +0530
Subject: [PATCH 2/2] Update README.md
---
README.md | 26 +++++++++-----------------
1 file changed, 9 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
index 380e3b7..3323158 100644
--- a/README.md
+++ b/README.md
@@ -194,6 +194,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 |
@@ -255,22 +263,6 @@ If you want to generate transformations in your application and add them to the
| raw | The string provided in raw will be added in the URL as it is. |
-##### Deprecation notice
-
-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.
-
-If you are creating overlay transformations using the JavaScript SDK, you can migrate to the new Layers syntax using the raw parameter:
-
-transformation : [
-{
- "width" : 300,
- "height" : 300
-},
-{
- "raw": "l-image,i-logo.png,w-10,rt-90,l-end"
- }]
-
-
### File Upload
The SDK provides a simple interface using the `.upload()` method to upload files to the ImageKit Media Library.
@@ -423,4 +415,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
+}