Skip to content

Commit

Permalink
docs: document build and start scripts
Browse files Browse the repository at this point in the history
Issue #47
  • Loading branch information
lewismoten committed Sep 2, 2019
1 parent eaa302b commit 34382dc
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,28 @@ The chunks would be written out as:
}
</script>
```

# 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

0 comments on commit 34382dc

Please sign in to comment.