From 3bcdc74fccc1ba21a777d476208773754a545393 Mon Sep 17 00:00:00 2001
From: John Carmichael <john@johnine.org>
Date: Mon, 25 Jan 2021 19:00:25 +0100
Subject: [PATCH] docs: toc added for easier reading

---
 README.md    | 24 +++++++++++++++++++++---
 package.json |  1 +
 2 files changed, 22 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 6f56be71b..c73c5ae41 100755
--- a/README.md
+++ b/README.md
@@ -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
diff --git a/package.json b/package.json
index 46dc130e1..693f1a6c2 100644
--- a/package.json
+++ b/package.json
@@ -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"