Skip to content

Commit

Permalink
add readme to jimp
Browse files Browse the repository at this point in the history
  • Loading branch information
hipstersmoothie committed Sep 9, 2024
1 parent 9b8d610 commit afa0917
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions packages/jimp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<div align="center">
<img width="200" height="200"
src="https://s3.amazonaws.com/pix.iemoji.com/images/emoji/apple/ios-11/256/crayon.png">
<h1>Jimp</h1>
<p>JavaScript Image Manipulation Program</p>
</div>

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
```

0 comments on commit afa0917

Please sign in to comment.