Skip to content

Commit 686e8a9

Browse files
ANKUR DWIVEDIANKUR DWIVEDI
authored andcommitted
update readme
1 parent f8209dd commit 686e8a9

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Ruby on Rails gem for [ImageKit](https://imagekit.io/) implements the new APIs a
1313
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.
1414

1515
Table of contents -
16+
* [Changelog](#changelog)
1617
* [Installation](#installation)
1718
* [Initialization](#initialization)
1819
- [CarrierWave](#carrierwave)
@@ -30,6 +31,13 @@ Table of contents -
3031
# Quick start guide
3132
Get started with [official quick start guide](https://docs.imagekit.io/getting-started/quickstart-guides/ruby-on-rails) for integrating ImageKit in Ruby on Rails.
3233

34+
## Changelog
35+
### SDK Version 3.0.0
36+
#### Breaking changes
37+
**1. Overlay syntax update**
38+
* In version 3.0.0, we've removed the old overlay syntax parameters 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.
39+
* You can migrate to the new Layers syntax using the `raw` transformation parameter.
40+
3341
## Installation
3442

3543
Add `imagekitio` dependency to your application's Gemfile:

0 commit comments

Comments
 (0)