From 91c7489680559c780f8da123c0e3f5d327e658fc Mon Sep 17 00:00:00 2001 From: Matthieu Moy Date: Fri, 8 Nov 2019 16:37:57 +0100 Subject: [PATCH] README.md: mention commands to generate the bundle Some users (like me) may not know npm, and still want to be able to get a usable bundle without learning the whole npm. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index ea42401..88f028f 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,18 @@ TOC is a library that will automatically generate a table of contents for your p npm install import '@firstandthird/toc' ``` +## Build locally + +Within this Git repository, you may build using: + +```sh +npm install +npm run build +``` + +The second command generates a `dist/toc.bundle.js` file that may be +included in HTML pages using e.g. ``. + ## Usage Import required scripts: