From 34382dc6e72289a7b615a899eeecda4cc0f5b4c3 Mon Sep 17 00:00:00 2001 From: Lewis Moten Date: Sun, 1 Sep 2019 21:02:20 -0500 Subject: [PATCH] docs: document `build` and `start` scripts Issue #47 --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 29a31e8..ab5dbd6 100644 --- a/README.md +++ b/README.md @@ -99,3 +99,28 @@ The chunks would be written out as: } ``` + +# Modifications + +## Building + +Building is done via webpack as a universal module definition (UMD) library. + +From terminal + +```bash +npm run build +``` + +1. Creates a script in development mode under /docs/dist/riff-wave-reader.js +1. Creates a script in production mode under /lib/dist/riff-wave-reader.js along with a sourcemap file + +## Local Testing + +From terminal + +```bash +npm run start +``` + +Your web browser will open http://localhost:3000/docs/index.html