Skip to content

Commit 58c087f

Browse files
committed
docs: improve README formatting and clarify encoding options
1 parent b47246e commit 58c087f

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -106,14 +106,14 @@ Optionally, you can include `transformationPosition` and `urlEndpoint` in the ob
106106
*A simple height and width transformation:*
107107

108108
```js
109-
var imageURL = imagekit.url({
110-
path: "/default-image.jpg",
111-
urlEndpoint: "https://ik.imagekit.io/your_imagekit_id/endpoint/",
112-
transformation: [{
113-
height: 300,
114-
width: 400
115-
}]
116-
});
109+
var imageURL = imagekit.url({
110+
path: "/default-image.jpg",
111+
urlEndpoint: "https://ik.imagekit.io/your_imagekit_id/endpoint/",
112+
transformation: [{
113+
height: 300,
114+
width: 400
115+
}]
116+
});
117117
```
118118

119119
*Result Example:*
@@ -266,7 +266,7 @@ The table below outlines the available overlay configuration options:
266266
| text | (For text overlays) The text content to display. | `text: "ImageKit"` |
267267
| input | (For image, video, or subtitle overlays) Relative path to the overlay asset. | `input: "logo.png"` or `input: "overlay-video.mp4"` |
268268
| color | (For solidColor overlays) RGB/RGBA hex code or color name for the overlay color. | `color: "FF0000"` |
269-
| encoding | Defines how the overlay input is encoded. Accepted values: `auto`, `plain`, `base64`. | `encoding: "auto"` |
269+
| encoding | Accepted values: `auto`, `plain`, `base64`. [Check this](#encoding-options) for more details. | `encoding: "auto"` |
270270
| transformation | An array of transformation objects to style the overlay. <br> - [Text Overlay Transformations](#text-overlay-transformations) <br> - [Subtitle Overlay Transformations](#subtitle-overlay-transformations) <br> - Image and video overlays support most [transformations](#supported-transformations). <br> See [ImageKit docs](https://imagekit.io/docs/transformations#overlay-using-layers) for more details. | `transformation: [{ fontSize: 50 }]` |
271271
| position | Sets the overlay’s position relative to the base asset. Accepts an object with `x`, `y`, or `focus`. The `focus` value can be one of: `center`, `top`, `left`, `bottom`, `right`, `top_left`, `top_right`, `bottom_left`, or `bottom_right`. | `position: { x: 10, y: 20 }` or `position: { focus: "center" }` |
272272
| timing | (For video base) Specifies when the overlay appears using `start`, `duration`, and `end` (in seconds); if both `duration` and `end` are set, `duration` is ignored. | `timing: { start: 5, duration: 10 }` |

0 commit comments

Comments
 (0)