@@ -19,6 +19,14 @@ rotation, extraction, compositing and gamma correction are available.
19
19
Most modern macOS, Windows and Linux systems running Node.js v10+
20
20
do not require any additional install or runtime dependencies.
21
21
22
+ ## Documentation
23
+
24
+ Visit [ sharp.pixelplumbing.com] ( https://sharp.pixelplumbing.com/ ) for complete
25
+ [ installation instructions] ( https://sharp.pixelplumbing.com/install ) ,
26
+ [ API documentation] ( https://sharp.pixelplumbing.com/api-constructor ) ,
27
+ [ benchmark tests] ( https://sharp.pixelplumbing.com/performance ) and
28
+ [ changelog] ( https://sharp.pixelplumbing.com/changelog ) .
29
+
22
30
## Examples
23
31
24
32
``` sh
@@ -43,6 +51,7 @@ sharp(inputBuffer)
43
51
sharp (' input.jpg' )
44
52
.rotate ()
45
53
.resize (200 )
54
+ .jpeg ({ mozjpeg: true })
46
55
.toBuffer ()
47
56
.then ( data => { ... })
48
57
.catch ( err => { ... });
@@ -84,23 +93,15 @@ readableStream
84
93
.pipe (writableStream);
85
94
```
86
95
87
- [ ![ Test Coverage] ( https://coveralls.io/repos/lovell/sharp/badge.svg?branch=master )] ( https://coveralls.io/r/lovell/sharp?branch=master )
88
- [ ![ N-API v3] ( https://img.shields.io/badge/N--API-v3-green.svg )] ( https://nodejs.org/dist/latest/docs/api/n-api.html#n_api_n_api_version_matrix )
89
-
90
- ### Documentation
91
-
92
- Visit [ sharp.pixelplumbing.com] ( https://sharp.pixelplumbing.com/ ) for complete
93
- [ installation instructions] ( https://sharp.pixelplumbing.com/install ) ,
94
- [ API documentation] ( https://sharp.pixelplumbing.com/api-constructor ) ,
95
- [ benchmark tests] ( https://sharp.pixelplumbing.com/performance ) and
96
- [ changelog] ( https://sharp.pixelplumbing.com/changelog ) .
97
-
98
- ### Contributing
96
+ ## Contributing
99
97
100
98
A [ guide for contributors] ( https://github.com/lovell/sharp/blob/master/.github/CONTRIBUTING.md )
101
99
covers reporting bugs, requesting features and submitting code changes.
102
100
103
- ### Licensing
101
+ [ ![ Test Coverage] ( https://coveralls.io/repos/lovell/sharp/badge.svg?branch=master )] ( https://coveralls.io/r/lovell/sharp?branch=master )
102
+ [ ![ N-API v3] ( https://img.shields.io/badge/N--API-v3-green.svg )] ( https://nodejs.org/dist/latest/docs/api/n-api.html#n_api_n_api_version_matrix )
103
+
104
+ ## Licensing
104
105
105
106
Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Lovell Fuller and contributors.
106
107
0 commit comments