Skip to content

Commit d6ce60f

Browse files
committed
Update readme
1 parent 3578d6a commit d6ce60f

File tree

3 files changed

+22
-2
lines changed

3 files changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# ACF Image Aspect Ratio Crop Field
22

3-
Welcome to the Advanced Custom Fields Image Aspect Ratio Crop repository on Github.
3+
[![Build Status](https://travis-ci.org/joppuyo/acf-image-aspect-ratio-crop.svg?branch=master)](https://travis-ci.org/joppuyo/acf-image-aspect-ratio-crop)
44

5-
ACF field that allows user to crop image to a specific aspect ratio
5+
A field for Advanced Custom Field that forces the user to crop their image to specific aspect ratio after uploading. This is especially useful in responsive image use cases.
6+
7+
After cropping, a new cropped image variant is created in the gallery and saved into the post. Thumbnails are also generated for the new image. User can re-crop the original image at any time from the post page.
8+
9+
The cropped image variants are hidden by default in the media browser and on the media page but you can view then my selecting the "list view".
10+
11+
## Cropping an image to 16:9 aspect ratio
12+
13+
![Screenshot of cropping an image](assets/images/screenshot-1.png)
14+
15+
## Option to re-crop the image after upload
16+
17+
![Screenshot of the image field](assets/images/screenshot-2.png)
18+
19+
## Thanks
20+
21+
Special thanks to Anders Thorborg for [ACF Image Crop](https://github.com/andersthorborg/ACF-Image-Crop) which served as a inspiration for this plugin. Also, thanks to Fengyuan Chen for the [cropper.js](https://fengyuanchen.github.io/cropperjs/) library!
22+
23+
## License
24+
25+
GPL v2 or later

assets/images/screenshot-1.png

831 KB
Loading

assets/images/screenshot-2.png

85.5 KB
Loading

0 commit comments

Comments
 (0)