sharp-read-bmp/README.md

23 lines
No EOL
563 B
Markdown

# sharp-read-bmp
Function for reading bmp and ico and returning a sharp instance
[![][mit-badge]][mit]
Installation
----------------------------------------------------------------
```
npm install @valkyriecoms/sharp-read-bmp
```
Usage
----------------------------------------------------------------
```javascript
import { sharpBmp } from 'sharp-read-bmp';
import { fileTypeFromFile } from 'file-type';
const { mime } = await fileTypeFromFile('favicon.ico');
const sharpCtx = await sharpBmp('favicon.ico', mime);
console.log(await sharpCtx.metadata());
```