Skip to content

Commit

Permalink
chore: update to generator v6 (#63)
Browse files Browse the repository at this point in the history
  • Loading branch information
brandonocasey authored and gkatsev committed Jul 5, 2018
1 parent 48afd13 commit 4ac2452
Show file tree
Hide file tree
Showing 20 changed files with 8,908 additions and 2,415 deletions.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## Description
Briefly describe the issue.
Include a [reduced test case](https://css-tricks.com/reduced-test-cases/).

## Steps to reproduce
Explain in detail the exact steps necessary to reproduce the issue.

1.
2.
3.

## Results
### Expected
Please describe what you expected to see.

### Actual
Please describe what actually happened.

### Error output
If there are any errors at all, please include them here.

## Additional Information
Please include any additional information necessary here. Including the following:

### versions
#### videojs
what version of videojs does this occur with?

#### browsers
what browser are affected?

#### OSes
what platforms (operating systems and devices) are affected?

### plugins
are any videojs plugins being used on the page? If so, please list them below.
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Description
Please describe the change as necessary.
If it's a feature or enhancement please be as detailed as possible.
If it's a bug fix, please link the issue that it fixes or describe the bug in as much detail.

## Specific Changes proposed
Please list the specific changes involved in this pull request.

## Requirements Checklist
- [ ] Feature implemented / Bug fixed
- [ ] If necessary, more likely in a feature request than a bug fix
- [ ] Unit Tests updated or fixed
- [ ] Docs/guides updated
- [ ] Reviewed by Two Core Contributors
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,6 @@ npm-debug.log*
bower_components/
node_modules/

# Yeoman meta-data
.yo-rc.json

# Build-related directories
dist/
docs/api/
Expand Down
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lts/*
26 changes: 7 additions & 19 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,20 @@ sudo: false
dist: trusty
language: node_js
node_js:
- 'node'
- 'lts/argon'
- 'lts/*'
before_install:
- npm install -g greenkeeper-lockfile@1
before_script:

# Check if the current version is equal to the major version for the env.
- 'export IS_INSTALLED="$(npm list video.js | grep "video.js@$VJS")"'

# We have to add semicolons to the end of each line in the if as Travis runs
# this all on one line.
- 'if [ -z "$IS_INSTALLED" ]; then
echo "INSTALLING video.js@>=$VJS.0.0-RC.0 <$(($VJS+1)).0.0";
npm i "video.js@>=$VJS.0.0-RC.0 <\$(($VJS+1)).0.0";
else
echo "video.js@$VJS ALREADY INSTALLED";
fi'
- export CHROME_BIN=/usr/bin/google-chrome
- export DISPLAY=:99.0
- sh -e /etc/init.d/xvfb start
env:
- VJS=5
- VJS=6
- greenkeeper-lockfile-update
after_script: greenkeeper-lockfile-upload
addons:
# Commented out until Firefox works on Travis/with Karma again.
# firefox: latest
firefox: latest
apt:
sources:
- google-chrome
packages:
- google-chrome-stable

16 changes: 16 additions & 0 deletions .yo-rc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"generator-videojs-plugin": {
"scope": "",
"name": "overlay",
"description": "A plugin to display simple overlays during video playback.",
"author": "Brightcove, Inc.",
"license": "apache2",
"sass": true,
"ie8": true,
"docs": true,
"lang": false,
"husky": "lint",
"pluginType": "advanced",
"css": true
}
}
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,35 @@
# Video.js Overlay
# videojs-overlay

[![Build Status](https://travis-ci.org/brightcove/videojs-overlay.svg?branch=master)](https://travis-ci.org/brightcove/videojs-overlay)
[![Greenkeeper badge](https://badges.greenkeeper.io/brightcove/videojs-overlay.svg)](https://greenkeeper.io/)
[![Slack Status](http://slack.videojs.com/badge.svg)](http://slack.videojs.com)

[![NPM](https://nodei.co/npm/videojs-overlay.png?downloads=true&downloadRank=true)](https://nodei.co/npm/videojs-overlay/)

A plugin to display simple overlays - similar to YouTube's "Annotations" feature in appearance - during video playback.

_Note_: This meaning of an "overlay" is distinct from that of a modal dialog, which can overlay the entire player. This is built into video.js as [the `ModalDialog` component](http://docs.videojs.com/docs/api/modal-dialog.html).

Maintenance Status: Stable

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [Getting Started](#getting-started)
- [Documentation](#documentation)
- [Plugin Options](#plugin-options)
- [`align`](#align)
- [`showBackground`](#showbackground)
- [`attachToControlBar`](#attachtocontrolbar)
- [`class`](#class)
- [`content`](#content)
- [`overlays`](#overlays)
- [Examples](#examples)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->


## Getting Started

Once you've added the plugin script to your page, you can use it with any video:
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<source src="//vjs.zencdn.net/v/oceans.webm" type='video/webm'>
</video>
<ul>
<li><a href="test/">Run unit tests in browser.</a></li>
<li><a href="test/debug.html">Run unit tests in browser.</a></li>
</ul>
<script src="node_modules/video.js/dist/video.js"></script>
<script src="dist/videojs-overlay.js"></script>
Expand Down
Loading

0 comments on commit 4ac2452

Please sign in to comment.