Skip to content

Commit

Permalink
docs: tweak README wording and usage (#203)
Browse files Browse the repository at this point in the history
Closes #201

Some second-person wording has been rewritten to be more neutral, and an
example has been added of normal usage via an ES module import from an
installed package.
  • Loading branch information
ianprime0509 committed Mar 20, 2024
1 parent 67e1059 commit 0ad5136
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,24 @@ There are several implications of this for using various build and test tools: a
gives a more detailed overview (including suggestions for various tools) than
what can be covered in this README. The short version is that you may want to
consider migrating your own project to ES modules. If all else fails, you can
continue to use v3, as v4 contains no functional changes.
continue to use v3, as v4 contains only minor functional changes.

## Installation

You can install pitchy using NPM (or similar tools such as Yarn):
Pitchy can be installed using NPM (or similar tools such as Yarn):

```shell
npm install pitchy
```

You can also use a CDN, such as [esm.sh](https://esm.sh), directly from a
browser or Deno:
After installing, it can be used via an ES module import:

```js
import { PitchDetector } from "pitchy";
```

It is also possible to use a CDN, such as [esm.sh](https://esm.sh), directly
from a browser or Deno:

```js
import { PitchDetector } from "https://esm.sh/pitchy@4";
Expand Down

0 comments on commit 0ad5136

Please sign in to comment.