From dd8eeafedbbca8482f877551c13309b470cfe03d Mon Sep 17 00:00:00 2001
From: Logic <376693576@qq.com>
Date: Mon, 22 Oct 2018 20:52:15 +0800
Subject: [PATCH] Update README.md

---
 README.md | 33 ++++++++++++++++++++++++++++++++-
 1 file changed, 32 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c836213..aae9710 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,32 @@
-# vue-flip-down
\ No newline at end of file
+# vue-flip-down
+---
+[![npm](https://img.shields.io/npm/v/vue-flip-down.svg)](https://www.npmjs.com/package/vue-flip-down)
+
+这是一个简单的翻页倒计时vue组件，项目中有用到，所以提取了一下。
+
+### 安装
+```
+npm install vue-flip-down --save
+或
+yarn add vue-flip-down 
+```
+
+### 使用
+```
+import FlipDown from 'vue-flip-down';
+
+<FlipDown
+  :endDate="1540212399971"
+>
+```
+
+### 参数
+
+|名称|类型|默认值|描述|
+|----|----|----|----|
+|endDate|Date/Number|0|结束的时间，即倒计时会从当前时间一直到endDate停止，可以是一个日期对象，也可以是毫秒数|
+|type|Number|4|要怎么显示倒计时：4-日时分秒，3-时分秒，2-分秒，1-秒|
+
+----
+
+### End