forked from videojs/videojs-vimeo
-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Kevin Aguiar
committed
Feb 28, 2020
1 parent
15a48f7
commit 13932e9
Showing
4 changed files
with
5,410 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,43 @@ | ||
# Videojs Vimeo plugin | ||
# Videojs Vimeo plugin hard fork | ||
|
||
Videojs Vimeo plugin using the official Vimeo Player API. This is heavily | ||
inspired by the official [VideoJS YouTube project](https://github.com/videojs/videojs-youtube). | ||
#### videojs-vimeo official plugin fork for supporting videojs v7.6.6 onwards. | ||
|
||
This project is a hard fork of the currently unmaintained official videojs-vimeo plugin: https://github.com/videojs/videojs-vimeo | ||
|
||
This fork has some significant changes in project structure: | ||
|
||
- Build now uses rollup; | ||
|
||
- Project linting now uses eslint + videojs styleguide; | ||
|
||
- Project folder structure reworked; | ||
|
||
- Lib version reseted relative to the official plugin. | ||
|
||
## Installation | ||
|
||
For now, the package is not published on any package manager — download the dist file or | ||
point your package manage at this repo. | ||
```bash | ||
npm i @devmobiliza/videojs-vimeo | ||
// OR | ||
yarn add @devmobiliza/videojs-vimeo | ||
``` | ||
|
||
## Usage | ||
|
||
See [index.html](https://github.com/videojs/videojs-vimeo/blob/master/index.html) | ||
- CommonJS: | ||
|
||
```js | ||
import videojs from 'video.js'; | ||
import '@devmobiliza/videojs-vimeo/dist/videojs-vimeo.cjs'; | ||
``` | ||
|
||
- Module: | ||
|
||
## Fork Roadmap | ||
```js | ||
import videojs from 'video.js'; | ||
import '@devmobiliza/videojs-vimeo/dist/videojs-vimeo.esm'; | ||
``` | ||
|
||
- Project Linting with ESLINT videojs standard - DONE | ||
- Refac Project Structure removing unused files and branches - DONE | ||
- Build with Rollup -> DONE | ||
- New hotrebuild on file editing | ||
- CI with GithubActions + publishing on NPM supporting @Mobiliza namespace | ||
- Browser: | ||
|
||
[videojs]: http://videojs.com/ | ||
See [index.html](https://github.com/Mobiliza/videojs-vimeo/blob/master/index.html) |
Oops, something went wrong.