diff --git a/README.md b/README.md index 53f7c69..1a94dcb 100644 --- a/README.md +++ b/README.md @@ -119,14 +119,14 @@ Following options can be passed during initialization of transformImage that ret | Name | Type | Description | Default | |------------------|----------|----------------------------------------------------------------------|------------------------| -| sizeLimit | int | the byte size limit for the input file/blob | 16*1024*1024 = 16MB | +| sizeLimit | int | the byte size limit for the input file/blob | 16777216 bytes = 16MB | | outputType | enum | defines the output object format. Allowed values :- blob/base64/file | blob | | allowedFileTypes | []string | allowed types for the input file/blob e.g. PNG, JPEG, JPG | ["jpg", "png", "jpeg"] | ### Methods -### `resizeImage(imageFile, options, fileName) => {Promise}` +#### `resizeImage(imageFile, options, fileName) => {Promise}` #### Description: Resize an image file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..034e848 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,21 @@ +# Security Policy + +## Supported Versions + +Use this section to tell people about which versions of your project are +currently being supported with security updates. + +| Version | Supported | +| ------- | ------------------ | +| 5.1.x | :white_check_mark: | +| 5.0.x | :x: | +| 4.0.x | :white_check_mark: | +| < 4.0 | :x: | + +## Reporting a Vulnerability + +Use this section to tell people how to report a vulnerability. + +Tell them where to go, how often they can expect to get an update on a +reported vulnerability, what to expect if the vulnerability is accepted or +declined, etc.