Valkyriecoms/sharp-read-bmp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updated readme

Browse source
This commit is contained in:
Toastie (DCS Team) 2024-10-06 00:14:45 +13:00
parent 380d72830e
commit aea6f151fa
Signed by: toastie_t0ast
GPG key ID: 27F3B6855AFD40A4
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,2 +1,21 @@
# sharp-read-bmp
Function for reading bmp and ico and returning a sharp instance
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());
```