README.md
1# [jPlayer](http://jplayer.org/) : HTML5 Audio & Video for [jQuery](http://jquery.com/)
2
3Support for [Zepto](http://zeptojs.com/) 1.0+ compiled with the data module.
4
5## What is jPlayer?
6
7### jPlayer is a jQuery/Zepto plugin that allows you to:
8* **play and control media** files in your webpage.
9* create a **consistent interface** and experience across all browsers.
10* create and style a media player using **just HTML and CSS**.
11* add **audio** and **video** to your jQuery/Zepto projects.
12* support more devices using **HTML5**.
13* support older browsers using a Flash _fall-back/forward_.
14* control media on your website using a [JavaScript API](http://www.jplayer.org/latest/developer-guide/).
15
16### jPlayer supports:
17* HTML5: **mp3, m4a (AAC), m4v (H.264),** ogv*, oga*, wav*, webm*
18* Flash: **mp3, m4a (AAC), m4v (H.264),** rtmp, flv.
19
20_(*) Optional counterpart formats to increase HTML5 cross-browser support._
21
22## Bower Install
23* simple install using `bower install jplayer`
24* see <http://bower.io/> for more information.
25
26## Composer install
27
28Install jPlayer via composer by adding the following lines to your `composer.json` in your project:
29
30 // ...
31 "require": {
32 // ...
33 "happyworm/jPlayer": "2.*"
34 // ...
35 }
36 // ...
37 "config": {
38 "component-dir": "your/desired/asset/path"
39 },
40 // ...
41
42Then execute the following:
43
44 php composer.phar update
45
46Composer will now download all components and install the needed files into `your/desired/asset/path`, ready to use.
47
48## License
49[jPlayer](http://jplayer.org/) is licensed under the [MIT license](http://opensource.org/licenses/MIT).
50
51## More information:
52* [jPlayer.org](http://jplayer.org/)
53* [Quick Start Guide](http://www.jplayer.org/latest/quick-start-guide/)
54* [Developer Guide and API Reference](http://www.jplayer.org/latest/developer-guide/)
55
56## Author:
57Mark J Panaghiston [@thepag](http://twitter.com/thepag)
58[happyworm.com](http://happyworm.com/)
59