Skip to content

Commit 6ddb416

Browse files
committed
Docs: Add explanations for each module script.
1 parent 011c7d3 commit 6ddb416

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,11 @@ Install via [NPM](https://www.npmjs.com/package/blueimp-load-image):
7676
npm install blueimp-load-image
7777
```
7878

79-
Include the (combined and minified) JavaScript Load Image script in your HTML
79+
This will install the JavaScript files inside
80+
`./node_modules/blueimp-load-image/js/` relative to your current directory, from
81+
where you can copy them into a folder that is served by your web server.
82+
83+
Next include the combined and minified JavaScript Load Image script in your HTML
8084
markup:
8185

8286
```html
@@ -86,17 +90,31 @@ markup:
8690
Or alternatively, choose which components you want to include:
8791

8892
```html
93+
<!-- required for all operations -->
8994
<script src="js/load-image.js"></script>
9095

96+
<!-- required for scaling, cropping and as dependency for rotation -->
9197
<script src="js/load-image-scale.js"></script>
98+
99+
<!-- required to parse meta data and to restore the complete image head -->
92100
<script src="js/load-image-meta.js"></script>
101+
102+
<!-- required to parse meta data from images loaded via URL -->
93103
<script src="js/load-image-fetch.js"></script>
104+
105+
<!-- required for rotation and cross-browser image orientation -->
94106
<script src="js/load-image-orientation.js"></script>
95107

108+
<!-- required to parse Exif tags and cross-browser image orientation -->
96109
<script src="js/load-image-exif.js"></script>
110+
111+
<!-- required to display text mappings for Exif tags -->
97112
<script src="js/load-image-exif-map.js"></script>
98113

114+
<!-- required to parse IPTC tags -->
99115
<script src="js/load-image-iptc.js"></script>
116+
117+
<!-- required to display text mappings for IPTC tags -->
100118
<script src="js/load-image-iptc-map.js"></script>
101119
```
102120

0 commit comments

Comments
 (0)