diff --git a/README.md b/README.md index c5bce9af5..bf19c1209 100644 --- a/README.md +++ b/README.md @@ -12,22 +12,24 @@ Tone.js is a Web Audio framework for creating interactive music in the browser. # Installation -To install the latest stable version. +There are two ways to incorporate Tone.js into a proejct. First, it can be installed locally into a project using `npm`: ```bash -npm install tone +npm install tone // Install the latest stable version +npm install tone@next // Or, alternatively, use the 'next' version ``` -Or to install the 'next' version +Add Tone.js to a project using the JavaScript `import` syntax: -```bash -npm install tone@next +```js +import * as Tone from 'tone'; ``` -To import Tone.js: +Tone.js is also hosted at unpkg.com. It can be added directly within an HTML document, as long as it precedes any project scripts. [See the example here](https://github.com/Tonejs/Tone.js/blob/master/examples/simpleHtml.html) for more details. -```js -import * as Tone from 'tone' +```html + + ``` # Hello Tone diff --git a/Tone/component/analysis/DCMeter.ts b/Tone/component/analysis/DCMeter.ts index f2fad8d05..d36c9ed89 100644 --- a/Tone/component/analysis/DCMeter.ts +++ b/Tone/component/analysis/DCMeter.ts @@ -4,7 +4,7 @@ import { MeterBase, MeterBaseOptions } from "./MeterBase"; export type DCMeterOptions = MeterBaseOptions; /** - * DCMeter gets the raw value of the input signal at the current time. + * DCMeter gets the raw value of the input signal at the current time. See also {@link Meter}. * * @example * const meter = new Tone.DCMeter(); diff --git a/Tone/component/analysis/Meter.ts b/Tone/component/analysis/Meter.ts index d90ceb7c9..6d08e3725 100644 --- a/Tone/component/analysis/Meter.ts +++ b/Tone/component/analysis/Meter.ts @@ -14,6 +14,9 @@ export interface MeterOptions extends MeterBaseOptions { /** * Meter gets the [RMS](https://en.wikipedia.org/wiki/Root_mean_square) * of an input signal. It can also get the raw value of the input signal. + * Setting `normalRange` to `true` will covert the output to a range of + * 0-1. See an example using a graphical display + * [here](https://tonejs.github.io/examples/meter). See also {@link DCMeter}. * * @example * const meter = new Tone.Meter();