x15904151985/ArtPlayer
1
0 Fork 0
mirror of https://github.com/zhw2590582/ArtPlayer.git synced 2026-10-28 18:41:20 -08:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Harvey Zack committed 2018-11-12 18:17:14 +08:00
1 parent c1bf612dd3
commit f121991369
1 file changed
+26 -3
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+26 -3
View File
@@ -1,12 +1,16 @@
# ArtPlayer # ArtPlayer
> ArtPlayer is a modern HTML5 video player > ArtPlayer is a modern HTML5 video player
[size-url]: https://bundlephobia.com/result?p=artplayer
## Status ## Status
⚠️ This project is WIP and not ready for production use yet! ⚠️ This project is WIP and not ready for production use yet!
## Demo ## Demo
[Checkout the demo](https://blog.zhw-island.com/ArtPlayer/) [Checkout the demo](https://blog.zhw-island.com/ArtPlayer/)
## Introduction
## Install ## Install
``` ```
@@ -25,7 +29,7 @@ OR umd builds are also available
<script src="path/to/artplayer.js"></script> <script src="path/to/artplayer.js"></script>
``` ```
Expose the global variable to `window.Artplayer`. Will expose the global variable to `window.Artplayer`.
## Usage ## Usage
@@ -40,4 +44,23 @@ var app = new Artplayer({
}); });
``` ```
Note: You need to initialize a size for the container element. Note: You need to initialize a size for the container element, like:
```css
.artplayer-app {
width: 400px;
height: 300px;
}
```
## Configuration
## API
## Issue
## Contributors
## License
MIT © [Harvey Zack](https://www.zhw-island.com/)