Skip to content

Commit fcbe3e1

Browse files
committed
Add explanation of howler distribution files
Fixes goldfire#722
1 parent 8135725 commit fcbe3e1

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,13 @@ import {Howl, Howler} from 'howler';
9090
const {Howl, Howler} = require('howler');
9191
```
9292

93+
Included distribution files:
94+
95+
* **howler**: This is the default and fully bundled source the includes `howler.core` and `howler.spatial`. It inclues all functionality that howler comes with.
96+
* **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.
97+
* **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.
98+
99+
93100
### Examples
94101

95102
##### Most basic, play an MP3:

0 commit comments

Comments
 (0)