video.js/README.md

## Please Note!
The master branch is now the development branch for 5.0 and should be considered unstable until the first 5.0 release. If you're looking for the most recent stable release, please refer to the [stable branch](https://github.com/videojs/video.js/tree/stable).


![Video.js logo](https://i.cloudup.com/C3nAUZ-l4c.png)

# [Video.js - HTML5 Video Player](http://videojs.com)  [![Build Status](https://travis-ci.org/videojs/video.js.svg?branch=master)](https://travis-ci.org/videojs/video.js)

> Video.js is a web video player built from the ground up for an HTML5 world. It supports HTML5 and Flash video, as well as YouTube and Vimeo (through [plugins](https://github.com/videojs/video.js/wiki/Plugins)). It supports video playback on desktops and mobile devices. This project was started mid 2010, and the player is now used on over ~~50,000~~ 100,000 websites.

## Quick start
Thanks to the awesome folks over at [Fastly](http://www.fastly.com/), there's a free, CDN hosted version of Video.js that anyone can use. Simply add these includes to your document's
`<head>`:

```html
<link href="http://vjs.zencdn.net/4.12/video-js.css" rel="stylesheet">
<script src="http://vjs.zencdn.net/4.12/video.js"></script>
```

Then, whenever you want to use Video.js you can simply use the `<video>` element as your normally would, but with an additional `data-setup` attribute containing any Video.js options. These options
can include any Video.js option plus potential [plugin](https://github.com/videojs/video.js/wiki/Plugins) options, just make sure they're valid JSON!

```html
<video id="really-cool-video" class="video-js vjs-default-skin" controls
 preload="auto" width="640" height="264" poster="really-cool-video-poster.jpg"
 data-setup='{}'>
  <source src="really-cool-video.mp4" type='video/mp4'>
  <source src="really-cool-video.webm" type='video/webm'>
  <p class="vjs-no-js">
    To view this video please enable JavaScript, and consider upgrading to a web browser
    that <a href="http://videojs.com/html5-video-support/" target="_blank">supports HTML5 video</a>
  </p>
</video>
```

If you don't want to use auto-setup, you can leave off the `data-setup` attribute and initialize a video element manually.

```javascript
var player = videojs('really-cool-video', { /* Options */ }, function() {
  console.log('Good to go!');

  this.play(); // if you don't trust autoplay for some reason

  // How about an event listener?
  this.on('ended', function() {
    console.log('awww...over so soon?');
  });
});
```

If you're ready to dive in, the [documentation](docs/index.md) is the first place to go for more information. Generally the
[player API docs](docs/api/vjs.Player.md) are the most pertinent.

## Contributing
Video.js is a free and open source library, and we appreciate any help you're willing to give. Check out the [contributing guide](CONTRIBUTING.md).

## Building your own Video.js from source
To build your own custom version read the section on [contributing code](CONTRIBUTING.md#contributing-code) and ["Building your own copy"](CONTRIBUTING.md#building-your-own-copy-of-videojs) in the contributing guide.

## License

Video.js is licensed under the Apache License, Version 2.0. [View the license file](LICENSE)

Copyright 2014-2015 Brightcove, Inc.
Update README to warn about master being for 5.0 2015-03-31 01:48:04 +02:00			`## Please Note!`
			`The master branch is now the development branch for 5.0 and should be considered unstable until the first 5.0 release. If you're looking for the most recent stable release, please refer to the [stable branch](https://github.com/videojs/video.js/tree/stable).`


doc updates + readme quick start 2014-10-17 21:55:53 +03:00			`![Video.js logo](https://i.cloudup.com/C3nAUZ-l4c.png)`

Use svg instead of png to get better image quality 2014-12-14 07:16:48 +02:00			`# [Video.js - HTML5 Video Player](http://videojs.com) [![Build Status](https://travis-ci.org/videojs/video.js.svg?branch=master)](https://travis-ci.org/videojs/video.js)`
Version 3.0 BETA 2011-10-01 03:28:43 +03:00
updated options to include sans-children, and included self-hosted font blurb updated used by count 2014-10-29 00:00:34 +02:00			`> Video.js is a web video player built from the ground up for an HTML5 world. It supports HTML5 and Flash video, as well as YouTube and Vimeo (through [plugins](https://github.com/videojs/video.js/wiki/Plugins)). It supports video playback on desktops and mobile devices. This project was started mid 2010, and the player is now used on over ~~50,000~~ 100,000 websites.`
MAJOR REFACTOR: Restrcutured code into class-based components. Setup and configuring should still work the same, but controls and tech elements are now sub-classes for Component, which builds elements and applies event behaviors. Removed demo source code from repository root. Was receiving pull requests for the release files instead of source files. This makes it more clear where to make changes. 2011-11-29 22:40:05 +03:00
doc updates + readme quick start 2014-10-17 21:55:53 +03:00			`## Quick start`
			`Thanks to the awesome folks over at [Fastly](http://www.fastly.com/), there's a free, CDN hosted version of Video.js that anyone can use. Simply add these includes to your document's`
			`<head>`:

			```html
Updated version in quickstart example 2015-02-25 03:59:36 +02:00			`<link href="http://vjs.zencdn.net/4.12/video-js.css" rel="stylesheet">`
			`<script src="http://vjs.zencdn.net/4.12/video.js"></script>`
doc updates + readme quick start 2014-10-17 21:55:53 +03:00			```

			Then, whenever you want to use Video.js you can simply use the `<video>` element as your normally would, but with an additional `data-setup` attribute containing any Video.js options. These options
			`can include any Video.js option plus potential [plugin](https://github.com/videojs/video.js/wiki/Plugins) options, just make sure they're valid JSON!`

			```html
			`<video id="really-cool-video" class="video-js vjs-default-skin" controls`
			`preload="auto" width="640" height="264" poster="really-cool-video-poster.jpg"`
			`data-setup='{}'>`
			`<source src="really-cool-video.mp4" type='video/mp4'>`
			`<source src="really-cool-video.webm" type='video/webm'>`
			`<p class="vjs-no-js">`
			`To view this video please enable JavaScript, and consider upgrading to a web browser`
			`that <a href="http://videojs.com/html5-video-support/" target="_blank">supports HTML5 video</a>`
			`</p>`
			`</video>`
			```

			If you don't want to use auto-setup, you can leave off the `data-setup` attribute and initialize a video element manually.

			```javascript
			`var player = videojs('really-cool-video', { /* Options */ }, function() {`
			`console.log('Good to go!');`

			`this.play(); // if you don't trust autoplay for some reason`

			`// How about an event listener?`
			`this.on('ended', function() {`
			`console.log('awww...over so soon?');`
			`});`
			`});`
			```

Fixed two broken links to documentation. 2014-11-01 16:57:02 +02:00			`If you're ready to dive in, the [documentation](docs/index.md) is the first place to go for more information. Generally the`
			`[player API docs](docs/api/vjs.Player.md) are the most pertinent.`
Updated grunt script to add CSS/PNG/SWF files dist. Also did some renaming of files and folders. 2013-01-26 02:22:14 +03:00
normalizing markdown markup, whitespace, spelling 2013-02-26 01:13:58 +03:00			`## Contributing`
Updated readme and contrib guide. closes #645 close #397 With changes from @sh1ps and myself 2013-07-18 03:51:29 +03:00			`Video.js is a free and open source library, and we appreciate any help you're willing to give. Check out the [contributing guide](CONTRIBUTING.md).`
Continued updating all library pieces to support closure compiler. Renamed internal lib var to vjs instead of _V_. 2013-01-05 03:58:23 +03:00
Updated readme and contrib guide. closes #645 close #397 With changes from @sh1ps and myself 2013-07-18 03:51:29 +03:00			`## Building your own Video.js from source`
			`To build your own custom version read the section on [contributing code](CONTRIBUTING.md#contributing-code) and ["Building your own copy"](CONTRIBUTING.md#building-your-own-copy-of-videojs) in the contributing guide.`
Continued updating all library pieces to support closure compiler. Renamed internal lib var to vjs instead of _V_. 2013-01-05 03:58:23 +03:00
added license to readme 2013-04-29 03:35:21 +03:00			`## License`

Updated readme and contrib guide. closes #645 close #397 With changes from @sh1ps and myself 2013-07-18 03:51:29 +03:00			`Video.js is licensed under the Apache License, Version 2.0. [View the license file](LICENSE)`
added license to readme 2013-04-29 03:35:21 +03:00
update copyright 2015-04-29 00:14:05 +02:00			`Copyright 2014-2015 Brightcove, Inc.`