Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
lannymcnie committed Sep 15, 2017
1 parent 1fd1c36 commit ff25923
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions lib/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# lib directory
This directory contains a compressed version of the SoundJS library, including the most recent tagged release and the
This directory contains compressed versions of the SoundJS library, including the most recent tagged release and the
in-progress NEXT release.

Both combined and minified versions of the library are included. The former being useful for debugging, and the latter
Expand All @@ -9,16 +9,19 @@ You can also link to the libraries on the [CreateJS CDN](http://code.createjs.co
and shared caching across sites.

# libraries
**soundjs-VERSION.min.js** contains minified versions of all of the SoundJS classes (comments and white space stripped)
except for the Flash and Cordova audio plugins.
**flashaudioplugin-VERSION.min.js** contains minified versions of the Flash audio plugin.
**cordovaaudioplugin-VERSION.min.js** contains minified versions of the Cordova audio plugin.
**soundjs-VERSION.combined.js** contains all the SoundJS classes (except Flash and Cordova plugin classes) including
whitespace and comments.
**flashaudioplugin-VERSION.combined.js** contains all the Flash audio plugin classes.
**cordovaaudioplugin-VERSION.combined.js** contains all the Cordova audio plugin classes.
* **soundjs.js** the most recent _tagged_ version of all the SoundJS classes.
* **soundjs.min.js** the most recent tagged version, minified and stripped of comments and whitespace.
* **soundjs-NEXT.js** contains the _latest_ SoundJS classes.
* **soundjs-NEXT.min.js** is a minified version of the _latest updates_ to the library.

## plugins
SoundJS plugins are also minified for easy inclusion.
* **flashplugin.js** a plugin to utilize Adobe Flash to playback audio.
* **flashplugin.js** a minified version of the flash plugin, stripped of comments and whitespace.
* **cordovaplugin.js** a plugin to utilize Cordova/PhoneGap APIs to playback audio.
* **cordovaplugin.js** a minified version of the cordova plugin, stripped of comments and whitespace.


# license
The libraries are ©2010 gskinner.com, inc., and made available under the highly permissive MIT open source software
The libraries are ©20107 gskinner.com, inc., and made available under the highly permissive MIT open source software
license. See the source file header for the full license text.

0 comments on commit ff25923

Please sign in to comment.