Skip to content

Commit

Permalink
Add explanation of howler distribution files
Browse files Browse the repository at this point in the history
Fixes #722
  • Loading branch information
goldfire committed Jun 20, 2021
1 parent 8135725 commit fcbe3e1
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,13 @@ import {Howl, Howler} from 'howler';
const {Howl, Howler} = require('howler');
```

Included distribution files:

* **howler**: This is the default and fully bundled source the includes `howler.core` and `howler.spatial`. It inclues all functionality that howler comes with.
* **howler.core**: This includes only the core functionality that aims to create parity between Web Audio and HTML5 Audio. It doesn't include any of the spatial/stereo audio functionality.
* **howler.spatial**: This is a plugin that adds spatial/stereo audio functionality. It requires `howler.core` to operate as it is simply an add-on to the core.


### Examples

##### Most basic, play an MP3:
Expand Down

0 comments on commit fcbe3e1

Please sign in to comment.