From afa0917b57b1c55f6e22981c2e57f626328c73f9 Mon Sep 17 00:00:00 2001 From: Andrew Lisowski Date: Mon, 9 Sep 2024 09:04:34 -0700 Subject: [PATCH] add readme to jimp --- packages/jimp/README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 packages/jimp/README.md diff --git a/packages/jimp/README.md b/packages/jimp/README.md new file mode 100644 index 00000000..81942f85 --- /dev/null +++ b/packages/jimp/README.md @@ -0,0 +1,41 @@ +
+ +

Jimp

+

JavaScript Image Manipulation Program

+
+ +The "JavaScript Image Manipulation Program" :-) + +An image processing library for Node written entirely in JavaScript, with zero native dependencies. + +The default jimp configuration. + +Supported types: + +- `@jimp/jpeg` +- `@jimp/png` +- `@jimp/bmp` +- `@jimp/tiff` +- `@jimp/gif` + +[Read the full docs.](http://jimp-dev.github.io/jimp/) + +## Installation + +```bash +npm install --save jimp +``` + +## Usage + +```js +const { Jimp } = require("jimp"); + +// open a file called "lenna.png" +const image = await Jimp.read("test.png"); + +image.resize(256, 256); // resize + +await image.write("test-small.jpg"); // save +```