mirror of
https://github.com/lovell/sharp.git
synced 2025-07-11 11:30:15 +02:00
d26f6b3b89
Add structure via mkdocs (replaces ever-growing README) Inline usage examples with the method they demonstrate Add changelog
34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
# sharp
|
|
|
|
The typical use case for this high speed Node.js module
|
|
is to convert large images of many formats to
|
|
smaller, web-friendly JPEG, PNG and WebP images of varying dimensions.
|
|
|
|
[](https://coveralls.io/r/lovell/sharp?branch=master)
|
|
|
|
### Documentation
|
|
|
|
Visit [sharp.dimens.io](http://sharp.dimens.io/) for
|
|
complete installation instructions, API documentation,
|
|
benchmark tests and a changelog.
|
|
|
|
### Contributing
|
|
|
|
A [guide for contributors](https://github.com/lovell/sharp/blob/master/CONTRIBUTING.md)
|
|
covers reporting bugs, requesting features and submitting code changes.
|
|
|
|
### Licence
|
|
|
|
Copyright 2013, 2014, 2015 Lovell Fuller and contributors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|