Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: tweak README wording and usage #203

Merged
merged 1 commit into from
Mar 20, 2024
Merged

docs: tweak README wording and usage #203

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
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
Loading