UNPKG

1.75 kBMarkdownView Raw
1# videojs-dock
2
3[![Build Status](https://travis-ci.org/brightcove/videojs-dock.svg?branch=master)](https://travis-ci.org/brightcove/videojs-dock)
4[![Greenkeeper badge](https://badges.greenkeeper.io/brightcove/videojs-dock.svg)](https://greenkeeper.io/)
5[![Slack Status](http://slack.videojs.com/badge.svg)](http://slack.videojs.com)
6
7[![NPM](https://nodei.co/npm/videojs-dock.png?downloads=true&downloadRank=true)](https://nodei.co/npm/videojs-dock/)
8
9A dock for videojs
10
11Maintenance Status: Stable
12
13
14<!-- START doctoc generated TOC please keep comment here to allow auto update -->
15<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
16
17
18- [Getting Started](#getting-started)
19 - [Running Tests](#running-tests)
20 - [Tag and Release](#tag-and-release)
21- [License](#license)
22
23<!-- END doctoc generated TOC please keep comment here to allow auto update -->
24
25## Getting Started
26
271. Clone this repository!
281. Install dependencies: `npm install`
291. Run a development server: `npm start`
30
31That's it! Refer to the [video.js plugin standards](https://github.com/videojs/generator-videojs-plugin/docs/standards.md) for more detail.
32
33### Running Tests
34
35- In all available and supported browsers: `npm test`
36- In a specific browser: `npm run test:chrome`, `npm run test:firefox`, etc.
37- While development server is running, navigate to [`http://localhost:9999/test/`](http://localhost:9999/test/) (_note:_ port may vary, check console output)
38
39### Tag and Release
40
411. Make sure everything is committed.
421. `npm version *` where `*` is `major`, `minor`, `patch`, etc. [Read more about versioning.](https://github.com/videojs/generator-videojs-plugin/docs/standards.md#versioning)
431. `npm publish`
44
45## License
46
47Apache-2.0. Copyright (c) Brightcove, Inc.