Skip to content

Commit

Permalink
Updated README and package information.
Browse files Browse the repository at this point in the history
  • Loading branch information
blueimp committed Jul 11, 2012
1 parent e8c0240 commit 4817008
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Expand Up @@ -89,6 +89,7 @@ The optional third argument is a map of options:
* **minWidth**: Defines the minimum width of the img/canvas element. * **minWidth**: Defines the minimum width of the img/canvas element.
* **minHeight**: Defines the minimum height of the img/canvas element. * **minHeight**: Defines the minimum height of the img/canvas element.
* **canvas**: Defines if the returned element should be a [canvas](https://developer.mozilla.org/en/HTML/Canvas) element. * **canvas**: Defines if the returned element should be a [canvas](https://developer.mozilla.org/en/HTML/Canvas) element.
* **noRevoke**: By default, the [created object URL](https://developer.mozilla.org/en/DOM/window.URL.createObjectURL) is revoked after the image has been loaded, except when this option is set to *true*.


They can be used the following way: They can be used the following way:


Expand All @@ -103,12 +104,13 @@ window.loadImage(
maxHeight: 300, maxHeight: 300,
minWidth: 100, minWidth: 100,
minHeight: 50, minHeight: 50,
canvas: true canvas: true,
noRevoke: true
} }
); );
``` ```


All options are optional. By default, the image is returned as HTML **img** element without any image size restrictions. All settings are optional. By default, the image is returned as HTML **img** element without any image size restrictions.


## License ## License
The JavaScript Load Image script is released under the [MIT license](http://www.opensource.org/licenses/MIT). The JavaScript Load Image script is released under the [MIT license](http://www.opensource.org/licenses/MIT).
2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{ {
"name": "blueimp-load-image", "name": "blueimp-load-image",
"version": "1.1.7", "version": "1.2",
"title": "JavaScript Load Image", "title": "JavaScript Load Image",
"description": "JavaScript Load Image is a function to load images provided as File or Blob objects or via URL. It returns an optionally scaled HTML img or canvas element.", "description": "JavaScript Load Image is a function to load images provided as File or Blob objects or via URL. It returns an optionally scaled HTML img or canvas element.",
"keywords": [ "keywords": [
Expand Down

0 comments on commit 4817008

Please sign in to comment.