Skip to content

Commit

Permalink
Updated README in preperation for v0.1.8
Browse files Browse the repository at this point in the history
Also updated references to dependenies on `video.js` and `video.js`.
They no longer need to be explicitly installed since they are now
defined as dependnecies.
  • Loading branch information
LonnyGomes committed Jan 7, 2017
1 parent de3a458 commit 2fe91fa
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ An angular.js directive for video.js
[![npm version](https://badge.fury.io/js/vjs-video.svg)](https://badge.fury.io/js/vjs-video)
[![Bower version](https://badge.fury.io/bo/vjs-video.svg)](https://badge.fury.io/bo/vjs-video)

With `vjs-video`, you can easily incorporate video and audio into your Angular projects using the robust HTML video player `video.js`.
With `vjs-video`, you can easily incorporate video and audio into your Angular projects using the robust HTML video player `video.js`.

The `vjs-video` directive handles all of the complexity involved with using `video.js` within an AngularJS Single Page App (SPA) and includes the following features:

Expand All @@ -27,13 +27,13 @@ The `vjs-video` directive avaible via both npm and bower.

## npm

Use npm to install `vjs-video` and all of it's dependencies.
Use npm to install `vjs-video`. The angular and video.js modules will also be installed as dependencies if they aren't already defined.

```bash
npm install --save angular video.js vjs-video
npm install --save vjs-video
```

You then can import the directive manually in a script tag or with your module loader of choice.
You then can import the directive manually in a script tag or with your module loader of choice.

> See [here](https://github.com/LonnyGomes/vjs-video-webpack-example) for an example of using `vjs-video` with webpack.
Expand Down Expand Up @@ -228,6 +228,12 @@ Running `grunt test` will run the unit tests with karma.

## Release History

**_v0.1.8_**

* fixed error where v0.1.7 failed to include proper minified files (#58)
* added `video.js` and `angular` dependencies to the package.json (#59)
* updated README regaurding dependencies on `video.js` and `angular`

**_v0.1.7_**

* added support for CommonJS and AMD module loaders (#42)
Expand Down

0 comments on commit 2fe91fa

Please sign in to comment.