Skip to content

Commit 3aeb6f5

Browse files
committed
readme update
1 parent 12a7afa commit 3aeb6f5

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
[![Dependencies](https://david-dm.org/chrisweb/web-audio-api-player/status.svg)](https://david-dm.org/chrisweb/web-audio-api-player)
22
[![Dependencies](https://david-dm.org/chrisweb/web-audio-api-player/dev-status.png)](https://david-dm.org/chrisweb/web-audio-api-player)
3-
[![GitHub release](https://img.shields.io/github/release/chrisweb/web-audio-api-player.svg)](https://github.com/chrisweb/web-audio-api-player/releases)
3+
[![npm version](https://img.shields.io/npm/v/web-audio-api-player.svg?style=flat)](https://www.npmjs.com/package/web-audio-api-player)
4+
[![GitHub license](https://img.shields.io/github/license/chrisweb/web-audio-api-player)](https://github.com/chrisweb/web-audio-api-player/blob/master/LICENSE)
45

56
# web audio API player
67

8+
## installation
9+
10+
web audio API player is published to the [npm registry](https://npm.im/web-audio-api-player) so you can install it with either [npm](https://www.npmjs.com/get-npm) or [yarn](https://yarnpkg.com)
11+
12+
`npm install web-audio-api-player`
13+
14+
😔 there is no documentation yet, but check out the source code of the [simple player example](examples/simple-player)
15+
716
## W3C web audio API
817

918
[W3C Candidate Recommendation, 18 September 2018](https://www.w3.org/TR/webaudio/)
@@ -12,7 +21,7 @@
1221

1322
Support tables for audio features, [caniuse: web audio API / audio element / formats ...](https://caniuse.com/#search=audio)
1423

15-
## build
24+
## development: build
1625

1726
install the latest nodejs (if you haven't already) [nodejs](https://nodejs.org)
1827
update npm to latest version
@@ -32,19 +41,19 @@ to build the distributions
3241

3342
in devlopment you can use watch to rebuild every time you edit a typescript file
3443

35-
## development (watch)
44+
## development: watch
3645

3746
`npm run watch`
3847

39-
## linting
48+
## development: linting
4049

4150
to lint the typescript files
4251

4352
`npm run lint`
4453

45-
## usage
54+
## examples
4655

47-
the best way to get started is to check out the examples folder, start with [simple example](examples/simple-player)
56+
the best way to get started is to check out the examples folder, start with [simple player example](examples/simple-player)
4857

4958
## notes about problems I encountered during development
5059

0 commit comments

Comments
 (0)