xgplayer 3.0.1 → 3.0.2

package/README.md

@@ -5,9 +5,6 @@
     <a href="https://www.npmjs.com/package/xgplayer" target="_blank">
         <img src="https://img.shields.io/npm/v/xgplayer.svg" alt="npm">
     </a>
-    <a href="https://www.npmjs.com/package/xgplayer">
-        <img src="https://img.shields.io/npm/dm/xgplaer.svg" alg="download">
-    </a>
     <a href="https://www.npmjs.com/package/xgplayer" target="_blank">
         <img src="https://img.shields.io/npm/l/xgplayer.svg" alt="license">
     </a>
@@ -19,14 +16,14 @@
 
 ### Introduction
 
-xgplayer is a web video player library. it has designed a separate, detachable UI component based on the principle that everything is componentized. More importantly, it is not only flexible in the UI layer, but also bold in its functionality: it gets rid of video loading, buffering, and format support for video dependence. Especially on mp4
-it can be staged loading for that does not support streaming mp4. This means seamless switching with clarity, load control, and video savings. It also integrates on-demand and live support for FLV, HLS, and dash. [Document](http://h5player.bytedance.com/)
+xgplayer is a web video player library. It has designed a separate, detachable UI component based on the principle that everything is componentized. More importantly, it is not only flexible in the UI layer, but also bold in its functionality: it gets rid of video loading, buffering, and format support for video dependence. Especially on mp4
+it can be staged loading for that does not support streaming mp4. This means seamless switching with clarity, load control, and video savings. It also integrates on-demand and live support for FLV, HLS, and dash. [Document](http://h5player.bytedance.com/en/)
 
 ### Start
 
 1. Install
 
-    ```
+    ```bash
     $ npm install xgplayer
     ```
 
@@ -48,51 +45,37 @@ it can be staged loading for that does not support streaming mp4. This means sea
     })
     ```
 
-    This is the easiest way to configure the player,then it runs with video. For more advanced content, see the plug-in section or documentation. [more config](http://h5player.bytedance.com/config.html)
+    This is the easiest way to configure the player, then it runs with video. For more advanced content, see the plug-in section or documentation. [more config](http://h5player.bytedance.com/en/config/)
 
 
 
 
 ### Plugins
 
-xgplayer provides more plugins, plugins are divided into two categories: one is self-starting, and another inherits the player's core class named xgplayer. In principle, the officially provided plug-ins are self-starting and the packaged third-party libraries are inherited. Some feature plug-ins themselves can provide a downgrade scenario that suggests a self-start approach, or an inheritance approach if not. The player supports custom plugins for more content viewing [plugins](http://h5player.bytedance.com/)
-
-The following is how to use a self-starting plug-in：
-
-```js
-import Player from 'xgplayer';
-import 'xgplyaer-mp4';
-
-const player = new Player({
-    id: 'video',
-    url: '//abc.com/test.mp4'
-})
-```
-
-<code>xgplayer-mp4</code>plugin is self-starting, It loads mp4 video itself, parses mp4 format, implements custom loading, buffering, seamless switching, and so on. it will automatically downgrade devices that do not support [MSE](https://www.w3.org/TR/media-source/). [details](http://h5player.bytedance.com/plugins/#xgplayer-mp4)
-
-
-
-### Mobile Support
-
-xgplayer supports mobile terminal, but android device brand and system are numerous, there are much compatibility problems, the player provides whitelist mechanism to ensure the perfect operation in mobile terminal. [whitelist](http://h5player.bytedance.com/config/#%E7%99%BD%E5%90%8D%E5%8D%95)
-
+xgplayer provides more plugins and supports custom plugins, for more content viewing [plugins](http://h5player.bytedance.com/en/plugins/). There are many built-in plugins in the player, if you need to close specific plugins, you can disable them by [ignores](https://h5player.bytedance.com/config/#ignores) configuration
 
 
 ### Dev
 
-For debugging, we provide the example video resource which size is large in github. You can clone the whole git repository which includes codes and example videos with 'git clone --recurse-submodules -j8'. With 'git clone' you will pull only codes of xgplayer and its plugins.
+In order to debug by developers, we provide demos code in the fixtures directory of the repo. The player uses yarn for package management, and it only takes a few simple steps to start debugging in the repo
 
-```
-$ git clone --recurse-submodules -j8 git@github.com:bytedance/xgplayer.git # OR git clone git@github.com:bytedance/xgplayer.git
+```bash
 $ cd xgplayer
-$ npm install
-$ npm run dev
+$ yarn
+$ yarn dev:xgplayer
 ```
 
-please visit [http://localhost:9090/examples/index.html](http://localhost:9090/examples/index.html)
+To debug other plugins, please refer to the scripts command provided in package.json in the root directory of the repo, such as:
 
+```bash
+$ yarn dev:hls
+$ yarn dev:flv
+$ yarn dev:mp4
+```
 
 ### License
 
-[MIT](http://opensource.org/licenses/MIT)
+Welcome to use xgplayer! Please read the following terms carefully. Using xgplayer means that you accept and agree to the terms.
+1. Xgplayer is licensed under the [MIT](http://opensource.org/licenses/MIT) License. You comply with its obligations by default.
+2. By default, you authorize us to place your logo in xgplayer website, which using xgplayer.
+If you have any problem, please let us know.