From f1219913697ccb9d2ef9a133a503cc5621006a42 Mon Sep 17 00:00:00 2001 From: Harvey Zack Date: Mon, 12 Nov 2018 18:17:14 +0800 Subject: [PATCH] update readme --- README.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d06442a74..c43f9ccfd 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ # ArtPlayer > ArtPlayer is a modern HTML5 video player +[size-url]: https://bundlephobia.com/result?p=artplayer + ## Status -⚠️ This project is WIP and not ready for production use yet! +⚠️ This project is WIP and not ready for production use yet! ## Demo [Checkout the demo](https://blog.zhw-island.com/ArtPlayer/) +## Introduction + ## Install ``` @@ -25,7 +29,7 @@ OR umd builds are also available ``` -Expose the global variable to `window.Artplayer`. +Will expose the global variable to `window.Artplayer`. ## Usage @@ -40,4 +44,23 @@ var app = new Artplayer({ }); ``` -Note: You need to initialize a size for the container element. \ No newline at end of file +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/) \ No newline at end of file