From 65db43779981a5bfe24bb973b39cad33b0bb904e Mon Sep 17 00:00:00 2001 From: Harvey Zack Date: Thu, 15 Nov 2018 09:14:41 +0800 Subject: [PATCH] update docs --- README.md | 107 ++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 83 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 890e689d6..37a7bd131 100644 --- a/README.md +++ b/README.md @@ -49,13 +49,18 @@ var art = new Artplayer({ }); ``` -## Configuration +## Ecosystem +| Project | Description | +| ------------------------------------------------------------------------------------------------------------- | -------------------------- | +| [artplayer-plugin-danmu](https://github.com/zhw2590582/ArtPlayer/tree/master/packages/artplayer-plugin-danmu) | Danmu plugin for ArtPlayer | + +## Configuration - + @@ -624,7 +629,7 @@ var art = new Artplayer({
parameter descriptionExampleexample
container
- Demo + Demo @@ -640,32 +645,86 @@ var art = new Artplayer({ }); ``` -#### Class static properties and methods - -| Parameter | Description | -| -------------------------------- | ------------------------- | -| Artplayer.version | Version Information | -| Artplayer.config | Configuration information | -| Artplayer.utils | Common utils | -| Artplayer.DEFAULTS | Default configuration | -| Artplayer.instances | Instance collection | -| Artplayer.use() | Function to load plugin | - #### Instance properties and methods + + + + + + + + + + + + + + + + + + + +
property / methodparameterdescriptionexample
art.init() + Initialization instance, in general you don't need it +
art.destroy()true / false + Destroy instance, and whether to remove dom + + Demo +
-| Method | Parameter | Description | -| -------------------------- | -------------------------------------- | ----------------------------------------------------- | -| art.init() | | Initialization instance, in general you don't need it | -| art.destroy() | true / false | Destroy instance, and whether to remove dom | +#### Class static properties and methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
property / methodparameterdescriptionexample
Artplayer.version + Version Information +
Artplayer.config + Configuration information +
Artplayer.utils + Common utils +
Artplayer.DEFAULTS + Default configuration +
Artplayer.use() + Function to load plugin +
#### Listening event -## Ecosystem - -| Project | Description | -| ------------------------------------------------------------------------------------------------------------- | -------------------------- | -| [artplayer-plugin-danmu](https://github.com/zhw2590582/ArtPlayer/tree/master/packages/artplayer-plugin-danmu) | Danmu plugin for ArtPlayer | - ## Issue ## Contributors