Skip to content

Commit 9815eb9

Browse files
manu4543manu4543
committed
readme update
1 parent ddd8617 commit 9815eb9

3 files changed

Lines changed: 87 additions & 53 deletions

File tree

‎README.md‎

Lines changed: 60 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,9 @@
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
77
[![Twitter Follow](https://img.shields.io/twitter/follow/imagekitio?label=Follow&style=social)](https://twitter.com/ImagekitIo)
88

9-
Java SDK for [ImageKit.io](https://imagekit.io/) that implements the new APIs and interface for performing different file
10-
operations.
9+
Java SDK for [ImageKit.io](https://imagekit.io/) that implements the new APIs and interface for performing different file operations.
1110

12-
ImageKit is a complete image optimization and transformation solution that comes with and
13-
[image CDN](https://imagekit.io/features/imagekit-infrastructure) and media storage. It can be integrated with your
14-
existing infrastructure - storage like AWS s3, web servers, your CDN, and custom domain names, allowing you to deliver
15-
optimize images in minutes with minimal code changes
11+
ImageKit is complete media storage, optimization, and transformation solution that comes with an [image and video CDN](https://imagekit.io). 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.
1612

1713
Table of contents -
1814
* [Installation](#installation)
@@ -303,49 +299,64 @@ transformation code from ImageKit docs as the name when using in the ```url``` f
303299

304300

305301
| Supported Transformation Name | Translates to parameter |
306-
| ----------------------------- | ----------------------- |
307-
| height | h |
308-
| width | w |
309-
| aspect_ratio | ar |
310-
| quality | q |
311-
| crop | c |
312-
| crop_mode | cm |
313-
| x | x |
314-
| y | y |
315-
| focus | fo |
316-
| format | f |
317-
| radius | r |
318-
| background | bg |
319-
| border | bo |
320-
| rotation | rt |
321-
| blur | bl |
322-
| named | n |
323-
| overlay_image | oi |
324-
| overlay_x | ox |
325-
| overlay_y | oy |
326-
| overlay_focus | ofo |
327-
| overlay_height | oh |
328-
| overlay_width | ow |
329-
| overlay_text | ot |
330-
| overlay_text_font_size | ots |
331-
| overlay_text_font_family | otf |
332-
| overlay_text_color | otc |
333-
| overlay_alpha | oa |
334-
| overlay_text_typography | ott |
335-
| overlay_background | obg |
336-
| overlay_image_trim | oit |
337-
| progressive | pr |
338-
| lossless | lo |
339-
| trim | t |
340-
| metadata | md |
341-
| color_profile | cp |
342-
| default_image | di |
343-
| dpr | dpr |
344-
| effect_sharpen | e-sharpen |
345-
| effect_usm | e-usm |
346-
| effect_contrast | e-contrast |
347-
| effect_gray | e-grayscale |
348-
| original | orig |
302+
|-------------------------------|-------------------------|
303+
| height | h |
304+
| width | w |
305+
| aspectRatio | ar |
306+
| quality | q |
307+
| crop | c |
308+
| cropMode | cm |
309+
| x | x |
310+
| y | y |
311+
| focus | fo |
312+
| format | f |
313+
| radius | r |
314+
| background | bg |
315+
| border | b |
316+
| rotation | rt |
317+
| blur | bl |
318+
| named | n |
319+
| overlayX | ox |
320+
| overlayY | oy |
321+
| overlayFocus | ofo |
322+
| overlayHeight | oh |
323+
| overlayWidth | ow |
324+
| overlayImage | oi |
325+
| overlayImageTrim | oit |
326+
| overlayImageAspectRatio | oiar |
327+
| overlayImageBackground | oibg |
328+
| overlayImageBorder | oib |
329+
| overlayImageDPR | oidpr |
330+
| overlayImageQuality | oiq |
331+
| overlayImageCropping | oic |
332+
| overlayImageFocus | oifo |
333+
| overlayText | ot |
334+
| overlayTextFontSize | ots |
335+
| overlayTextFontFamily | otf |
336+
| overlayTextColor | otc |
337+
| overlayTextTransparency | oa |
338+
| overlayAlpha | oa |
339+
| overlayTextTypography | ott |
340+
| overlayBackground | obg |
341+
| overlayTextEncoded | ote |
342+
| overlayTextWidth | otw |
343+
| overlayTextBackground | otbg |
344+
| overlayTextPadding | otp |
345+
| overlayTextInnerAlignment | otia |
346+
| overlayRadius | or |
347+
| progressive | pr |
348+
| lossless | lo |
349+
| trim | t |
350+
| metadata | md |
351+
| colorProfile | cp |
352+
| defaultImage | di |
353+
| dpr | dpr |
354+
| effectSharpen | e-sharpen |
355+
| effectUSM | e-usm |
356+
| effectContrast | e-contrast |
357+
| effectGray | e-grayscale |
358+
| original | orig |
359+
| raw | `replaced by the parameter value` |
349360

350361

351362
## File Upload

‎imagekit-sdk/src/main/java/io/imagekit/sdk/constants/Transformer.java‎

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,24 +26,38 @@ public static synchronized Transformer getInstance() {
2626
transformer.trans.put("format", "f");
2727
transformer.trans.put("radius", "r");
2828
transformer.trans.put("background", "bg");
29-
transformer.trans.put("border", "bo");
29+
transformer.trans.put("border", "b");
3030
transformer.trans.put("rotation", "rt");
3131
transformer.trans.put("blur", "bl");
3232
transformer.trans.put("named", "n");
33-
transformer.trans.put("overlayImage", "oi");
3433
transformer.trans.put("overlayX", "ox");
3534
transformer.trans.put("overlayY", "oy");
3635
transformer.trans.put("overlayFocus", "ofo");
3736
transformer.trans.put("overlayHeight", "oh");
3837
transformer.trans.put("overlayWidth", "ow");
38+
transformer.trans.put("overlayImage", "oi");
39+
transformer.trans.put("overlayImageTrim", "oit");
40+
transformer.trans.put("overlayImageAspectRatio", "oiar");
41+
transformer.trans.put("overlayImageBackground", "oibg");
42+
transformer.trans.put("overlayImageBorder", "oib");
43+
transformer.trans.put("overlayImageDPR", "oidpr");
44+
transformer.trans.put("overlayImageQuality", "oiq");
45+
transformer.trans.put("overlayImageCropping", "oic");
46+
transformer.trans.put("overlayImageFocus", "oifo");
3947
transformer.trans.put("overlayText", "ot");
4048
transformer.trans.put("overlayTextFontSize", "ots");
4149
transformer.trans.put("overlayTextFontFamily", "otf");
4250
transformer.trans.put("overlayTextColor", "otc");
51+
transformer.trans.put("overlayTextTransparency", "oa");
4352
transformer.trans.put("overlayAlpha", "oa");
4453
transformer.trans.put("overlayTextTypography", "ott");
4554
transformer.trans.put("overlayBackground", "obg");
46-
transformer.trans.put("overlayImageTrim", "oit");
55+
transformer.trans.put("overlayTextEncoded", "ote");
56+
transformer.trans.put("overlayTextWidth", "otw");
57+
transformer.trans.put("overlayTextBackground", "otbg");
58+
transformer.trans.put("overlayTextPadding", "otp");
59+
transformer.trans.put("overlayTextInnerAlignment", "otia");
60+
transformer.trans.put("overlayRadius", "or");
4761
transformer.trans.put("progressive", "pr");
4862
transformer.trans.put("lossless", "lo");
4963
transformer.trans.put("trim", "t");

‎imagekit-sdk/src/test/java/io/imagekit/sdk/GetUrlTest.java‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,15 @@ public void getUrl_with_transformation_parameters() {
180180
scale.put("effectGray", "");
181181
scale.put("original", String.valueOf(true));
182182
scale.put("raw", "w-200,h-200");
183+
scale.put("overlayImage", "oi");
184+
scale.put("overlayImageTrim", "oit");
185+
scale.put("overlayImageAspectRatio", "oiar");
186+
scale.put("overlayImageBackground", "oibg");
187+
scale.put("overlayImageBorder", "oib");
188+
scale.put("overlayImageDPR", "oidpr");
189+
scale.put("overlayImageQuality", "oiq");
190+
scale.put("overlayImageCropping", "oic");
191+
scale.put("overlayImageFocus", "oifo");
183192

184193
transformation.add(scale);
185194

@@ -190,7 +199,7 @@ public void getUrl_with_transformation_parameters() {
190199

191200
String url = SUT.getUrl(options);
192201
assertThat(
193-
"https://ik.imagekit.io/your_imagekit_id/tr:cm-extract,ofo-top,n-any_name,md-true,ow-20,e-contrast-1,fo-left,bl-10,ar-4-3,oit-false,e-usm-,oa-,obg-00AAFF55,ots-18,t-5,oh-20,cp-true,r-20,ox-20,ot-Image%20Text,oy-10,otc-00FFFF,di-folder@@file.jpg,h-600,bo-5-A94D34,orig-true,rt-90,dpr-3,f-png,raw-w-200,h-200,lo-true,e-grayscale-,q-40,ott-b,bg-A94D34,w-400,pr-true,e-sharpen,oi-folder@@file.jpg,c-force,otf-Open%20Sans/default-image.jpg",
202+
"https://ik.imagekit.io/your_imagekit_id/tr:cm-extract,ofo-top,n-any_name,md-true,ow-20,e-contrast-1,fo-left,bl-10,ar-4-3,oit-false,e-usm-,oa-,obg-00AAFF55,ots-18,t-5,oh-20,cp-true,r-20,ox-20,ot-Image%20Text,oy-10,otc-00FFFF,di-folder@@file.jpg,h-600,b-5-A94D34,orig-true,rt-90,dpr-3,f-png,raw-w-200,h-200,lo-true,e-grayscale-,q-40,ott-b,bg-A94D34,w-400,pr-true,e-sharpen,oi-folder@@file.jpg,c-force,otf-Open%20Sans/default-image.jpg",
194203
is(url));
195204
}
196205

0 commit comments

Comments
 (0)