# videojs-osg

on screen graphics

## Table of Contents

<!-- START doctoc -->
<!-- END doctoc -->
## Installation

```sh
npm install --save @youon/videojs-osg
```

## Usage

To include videojs-osg on your website or web application, use any of the following methods.

### `<script>` Tag

This is the simplest case. Get the script in whatever way you prefer and include the plugin _after_ you include [video.js][videojs], so that the `videojs` global is available.

```html
<script src="//path/to/video.min.js"></script>
<script src="//path/to/videojs-osg.min.js"></script>
<script>
  var player = videojs('my-video');

  player.osg();
</script>
```

### Browserify/CommonJS

When using with Browserify, install videojs-osg via npm and `require` the plugin as you would any other module.

```js
var videojs = require('video.js');

// The actual plugin function is exported by this module, but it is also
// attached to the `Player.prototype`; so, there is no need to assign it
// to a variable.
require('@youon/videojs-osg');

var player = videojs('my-video');

player.osg();
```

### RequireJS/AMD

When using with RequireJS (or another AMD library), get the script in whatever way you prefer and `require` the plugin as you normally would:

```js
require(['video.js', '@youon/videojs-osg'], function(videojs) {
  var player = videojs('my-video');

  player.osg();
});
```

## License

MIT. Copyright (c) Bruno Gomes &lt;bgomes@youongroup.com&gt;


[videojs]: http://videojs.com/