From c1bf612dd3c4d80d54481b1d86b89d31d6ba05e1 Mon Sep 17 00:00:00 2001
From: Harvey Zack <laozhaochaguan@gmail.com>
Date: Mon, 12 Nov 2018 16:00:55 +0800
Subject: [PATCH] update readme

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1234af82b..d06442a74 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,43 @@
 # ArtPlayer
-ArtPlayer is a modern HTML5 video player
+> ArtPlayer is a modern HTML5 video player
 
 ## Status
 ⚠️ This project is WIP and not ready for production use yet!
+
+## Demo
+[Checkout the demo](https://blog.zhw-island.com/ArtPlayer/)
+
+## Install
+
+```
+$ npm install --save artplayer
+```
+
+```js
+import Artplayer from 'artplayer';
+import 'artplayer/dist/artplayer.css';
+```
+
+OR umd builds are also available
+
+```html
+<link rel="stylesheet" href="path/to/artplayer.css">
+<script src="path/to/artplayer.js"></script>
+```
+
+Expose the global variable to `window.Artplayer`.
+
+## Usage
+
+```html
+<div class="artplayer-app"></div>
+```
+
+```js
+var app = new Artplayer({
+    container: '.artplayer-app',
+    url: 'path/to/video.mp4',
+});
+```
+
+Note: You need to initialize a size for the container element.
\ No newline at end of file