Skip to content

Commit 40deb6b

Browse files
committed
chore: add CHANGELOG.md and update README to include changelog reference
1 parent d9fa8ff commit 40deb6b

File tree

2 files changed

+73
-11
lines changed

2 files changed

+73
-11
lines changed

CHANGELOG.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Changelog
2+
3+
## SDK Version 3.0.0
4+
5+
### Breaking Changes
6+
7+
- **Overlay Syntax Update**
8+
In version 3.0.0, the old overlay syntax parameters for transformations (e.g., `oi`, `ot`, `obg`, and others as detailed [here](https://docs.imagekit.io/features/image-transformations/overlay)) have been removed. These parameters are deprecated and will now return errors when used in URLs.
9+
10+
**Action Required:**
11+
Migrate to the new layers syntax which supports overlay nesting, offers improved positional control, and allows more transformations at the layer level. For a quick start, refer to the [examples](https://docs.imagekit.io/features/image-transformations/overlay-using-layers#examples). Use the `raw` transformation parameter to implement this migration.
12+
13+
---
14+
15+
## SDK Version 2.0.0
16+
17+
### Breaking Changes
18+
19+
- **Authentication Process Update**
20+
Previously, client-side file uploads required the SDK to be initialized with both the `publicKey` and `authenticationEndpoint` to fetch security parameters (`signature`, `token`, and `expire`).
21+
22+
**Action Required:**
23+
With version 2.0.0, you must now generate the security parameters (`signature`, `token`, and `expire`) yourself, eliminating the need for the `authenticationEndpoint`. When invoking the SDK's upload method, be sure to include these parameters along with other [upload options](https://docs.imagekit.io/api-reference/upload-file-api/client-side-file-upload). For further details, consult the documentation [here](https://docs.imagekit.io/api-reference/upload-file-api/client-side-file-upload#signature-generation-for-client-side-file-upload).

README.md

Lines changed: 50 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
# ImageKit.io Javascript SDK
44

5+
## Table of Contents
6+
- [Changelog](#changelog)
7+
- [Installation](#installation)
8+
- [Initialization](#initialization)
9+
- [Demo Application](#demo-application)
10+
- [Usage](#usage)
11+
512
![gzip size](https://img.badgesize.io/https://unpkg.com/imagekit-javascript/dist/imagekit.min.js?compression=gzip&label=gzip)
613
![brotli size](https://img.badgesize.io/https://unpkg.com/imagekit-javascript/dist/imagekit.min.js?compression=brotli&label=brotli)
714
![Node CI](https://github.com/imagekit-developer/imagekit-javascript/workflows/Node%20CI/badge.svg)
@@ -15,16 +22,7 @@ Javascript SDK for [ImageKit](https://imagekit.io/) provides URL generation for
1522
ImageKit is complete media storage, optimization, and transformation solution that comes with an [image and video CDN](https://imagekit.io/features/imagekit-infrastructure). 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.
1623

1724
## Changelog
18-
### SDK Version 3.0.0
19-
#### Breaking changes
20-
**1. Overlay syntax update**
21-
* In version 3.0.0, we've removed the old overlay syntax parameters for transformations, such as `oi`, `ot`, `obg`, and [more](https://docs.imagekit.io/features/image-transformations/overlay). These parameters are deprecated 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.
22-
* You can migrate to the new layers syntax using the `raw` transformation parameter.
23-
### SDK Version 2.0.0
24-
#### Breaking changes
25-
**1. Authentication Process Update:**
26-
* Previously, when using client side file upload, the SDK required the `publicKey` and `authenticationEndpoint` parameters during SDK initialization to fetch security parameters (`signature`, `token`, and `expire`).
27-
* In version 2.0.0, we've updated the authentication process for the SDK. As a user of the SDK, you are now responsible for generating the security parameters (`signature`, `token`, and `expire`) yourself. This means you no longer need to provide the `authenticationEndpoint`. When using the SDK's upload method, make sure to pass these security parameters explicitly along with other [upload options](https://docs.imagekit.io/api-reference/upload-file-api/client-side-file-upload). For guidance on generating these security parameters, please refer to the documentation available [here](https://docs.imagekit.io/api-reference/upload-file-api/client-side-file-upload#signature-generation-for-client-side-file-upload).
25+
For a detailed history of changes, please refer to [CHANGELOG.md](CHANGELOG.md).
2826

2927
## Installation
3028

@@ -288,7 +286,48 @@ var imageURL = imagekit.url({
288286
https://ik.imagekit.io/your_imagekit_id/default-image.jpg?tr=w-iw_div_4,h-ih_div_2,b-cw_mul_0.05_yellow
289287
```
290288

291-
#### List of supported transformations
289+
### Key Advanced Transformations
290+
291+
#### Background Removal
292+
293+
```js
294+
var imageURL = imagekit.url({
295+
path: "/sample-image.jpg",
296+
transformation: [{
297+
aiRemoveBackground: true
298+
}]
299+
});
300+
console.log("Background Removed Image URL:", imageURL);
301+
// Expected: https://ik.imagekit.io/your_imagekit_id/tr:e-bgremove/sample-image.jpg
302+
```
303+
304+
#### Upscaling
305+
306+
```js
307+
var upscaledURL = imagekit.url({
308+
path: "/sample-image.jpg",
309+
transformation: [{
310+
aiUpscale: true
311+
}]
312+
});
313+
console.log("Upscaled Image URL:", upscaledURL);
314+
// Expected: https://ik.imagekit.io/your_imagekit_id/tr:e-upscale/sample-image.jpg
315+
```
316+
317+
#### AI Drop Shadow
318+
319+
```js
320+
var dropShadowURL = imagekit.url({
321+
path: "/sample-image.jpg",
322+
transformation: [{
323+
aiDropShadow: "az-45"
324+
}]
325+
});
326+
console.log("Image URL with Drop Shadow:", dropShadowURL);
327+
// Expected: https://ik.imagekit.io/your_imagekit_id/tr:e-dropshadow-az-45/sample-image.jpg
328+
```
329+
330+
### List of supported transformations
292331

293332
See the complete list of transformations supported in ImageKit [here](https://docs.imagekit.io/features/image-transformations). The SDK gives a name to each transformation parameter e.g. `height` for `h` and `width` for `w` parameter. It makes your code more readable. If the property does not match any of the following supported options, it is added as it is.
294333

0 commit comments

Comments
 (0)