Skip to content

Commit afa0917

Browse files
add readme to jimp
1 parent 9b8d610 commit afa0917

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

packages/jimp/README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<div align="center">
2+
<img width="200" height="200"
3+
src="https://s3.amazonaws.com/pix.iemoji.com/images/emoji/apple/ios-11/256/crayon.png">
4+
<h1>Jimp</h1>
5+
<p>JavaScript Image Manipulation Program</p>
6+
</div>
7+
8+
The "JavaScript Image Manipulation Program" :-)
9+
10+
An image processing library for Node written entirely in JavaScript, with zero native dependencies.
11+
12+
The default jimp configuration.
13+
14+
Supported types:
15+
16+
- `@jimp/jpeg`
17+
- `@jimp/png`
18+
- `@jimp/bmp`
19+
- `@jimp/tiff`
20+
- `@jimp/gif`
21+
22+
[Read the full docs.](http://jimp-dev.github.io/jimp/)
23+
24+
## Installation
25+
26+
```bash
27+
npm install --save jimp
28+
```
29+
30+
## Usage
31+
32+
```js
33+
const { Jimp } = require("jimp");
34+
35+
// open a file called "lenna.png"
36+
const image = await Jimp.read("test.png");
37+
38+
image.resize(256, 256); // resize
39+
40+
await image.write("test-small.jpg"); // save
41+
```

0 commit comments

Comments
 (0)