Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: toc added for easier reading #984

Merged
merged 1 commit into from Feb 9, 2021
Merged

docs: toc added for easier reading #984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 21 additions & 3 deletions README.md
View file
Open in desktop
@@ -1,20 +1,38 @@

<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>
<p>An image processing library for Node written entirely in JavaScript, with zero native dependencies.</p>
</div>

An image processing library for Node written entirely in JavaScript, with zero native dependencies.
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*

Installation: `npm install --save jimp`
- [Installation](#installation)
- [Tools](#tools)
- [Supported Image Types](#supported-image-types)
- [Image Manipulation Methods (Default Plugins)](#image-manipulation-methods-default-plugins)
- [Extra Plugins](#extra-plugins)
- [Custom Jimp](#custom-jimp)
- [Contributing](#contributing)
- [License](#license)
- [Project Using Jimp](#project-using-jimp)

API documentation can be found in the main [jimp package](./packages/jimp)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->

> ## Notice of potentially breaking change
>
> As of v0.10.4, core-js is no longer included with jimp or its extensions. If you rely on core-js, install it with either `yarn add core-js` or `npm i core-js`

## Installation

Installation: `npm install --save jimp`

API documentation can be found in the main [jimp package](./packages/jimp)

## Tools

:hammer: [cli](./packages/cli) - Jimp as a CLI program. Can load and run all plugins
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Expand Up @@ -21,6 +21,7 @@
"clean:build": "rm -rf packages/**/es packages/**/dist",
"build": "npm run clean:build && lerna run build --stream",
"build:watch": "lerna run build:watch --parallel",
"build:readme-toc": "npx doctoc ./README.md",
"release": "auto shipit",
"tsTest:custom": "dtslint packages/custom/types --expectOnly",
"tsTest:main": "dtslint packages/jimp/types --expectOnly"
Expand Down