vuejs-countdown-timer - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

package.json

 {
   "name": "vuejs-countdown-timer",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Vue 2 countdown and timer component",
-  "main": "/dist/vue-countdown-timer.js",
+  "main": "/dist/vuejs-countdown-timer.min.js",
   "scripts": {
@@ -11,3 +11,3 @@ "build": "webpack -p"
     "type": "git",
-    "url": "git+https://github.com/TriDiamond/vue-countdown-timer.git"
+    "url": "git+https://github.com/TriDiamond/vuejs-countdown-timer.git"
   },
@@ -23,5 +23,5 @@ "keywords": [
   "bugs": {
-    "url": "https://github.com/TriDiamond/vue-countdown-timer/issues"
+    "url": "https://github.com/TriDiamond/vuejs-countdown-timer/issues"
   },
-  "homepage": "https://github.com/TriDiamond/vue-countdown-timer#readme",
+  "homepage": "https://github.com/TriDiamond/vuejs-countdown-timer#readme",
   "devDependencies": {
@@ -28,0 +28,0 @@ "babel-core": "^6.26.0",

README.md

 # Vue-countdown-timer Component
 
 <p>
-  <a href="https://circleci.com/gh/TriDiamond/vue-photoswipe/tree/master">
-    <img src="https://img.shields.io/circleci/project/github/TriDiamond/vue-photoswipe.svg" alt="Build Status">
+  <a href="https://circleci.com/gh/TriDiamond/vuejs-countdown-timer/tree/master">
+    <img src="https://img.shields.io/circleci/project/github/TriDiamond/vuejs-countdown-timer.svg" alt="Build Status">
   </a>
-  <a href="https://github.com/TriDiamond/vue-photoswipe/stargazers">
-    <img src="https://img.shields.io/github/stars/TriDiamond/vue-photoswipe.svg" alt="Github starts">
+  <a href="https://github.com/TriDiamond/vuejs-countdown-timer/stargazers">
+    <img src="https://img.shields.io/github/stars/TriDiamond/vuejs-countdown-timer.svg" alt="Github starts">
   </a>
   <a>
-    <img src="https://img.shields.io/github/license/TriDiamond/vue-photoswipe.svg" alt="License">
+    <img src="https://img.shields.io/github/license/TriDiamond/vuejs-countdown-timer.svg" alt="License">
   </a>
   <a href="https://www.npmjs.com/package/vue-photoswipes">
-    <img src="https://img.shields.io/npm/dt/vue-photoswipes.svg" alt="Npm downloads">
+    <img src="https://img.shields.io/npm/dt/vuejs-countdown-timer.svg" alt="Npm downloads">
   </a>
@@ -20,2 +20,4 @@ </p>
 
+[📙中文文档](https://github.com/TriDiamond/vuejs-countdown-timer/blob/master/README_CN.md)
+
 ## Installation
@@ -42,3 +44,3 @@
 // global register
-import VueCountdownTimer from 'vue-countdown-timer'
+import VueCountdownTimer from 'vuejs-countdown-timer'
 Vue.use(VueCountdownTimer)
@@ -50,3 +52,3 @@
 // or for a single instance
-import VueCountdownTimer from 'vue-countdown-timer'
+import VueCountdownTimer from 'vuejs-countdown-timer'
 
@@ -70,14 +72,14 @@ components: {
 <vue-countdown-timer
-  @start_callback="startCallBack('活动开始')"
-  @end_callback="endCallBack('活动结束')"
+  @start_callback="startCallBack('event started')"
+  @end_callback="endCallBack('event ended')"
   :current-time="1481450106"
   :start-time="1481450110"
   :end-time="1481450115"
-  :tip-text="'距离开始文字1'"
-  :tip-text-end="'距离结束文字1'"
-  :end-text="'结束自定义文字2'"
-  :day-txt="'天'"
-  :hour-txt="'小时'"
-  :minutes-txt="'分钟'"
-  :seconds-txt="'秒'">
+  :tip-text="'Until start'"
+  :tip-text-end="'Until end'"
+  :end-text="'Event ended'"
+  :day-txt="'days'"
+  :hour-txt="'hours'"
+  :minutes-txt="'minutes'"
+  :seconds-txt="'seconds'">
 </vue-countdown-timer>
@@ -88,48 +90,58 @@ ```
 
-1. **currentTime** - 当前时间戳,如果不传,默认获取用户本地的时间(建议传服务器的当前时间) 
-    - **type**: Number
-    - **required** : false
-    - **default** : ( new Date() ).getTime()
-2. **startTime** - 开始时间戳
-    - **type**: Number
-    - **required** : true
-3. **endTime** - 结束时间戳
-    - **type**: Number
-    - **required** : true
-4. **tipText** - 开始倒计时之前的提示文字
-    - **type**: String
-    - **required** : false
-    - **default** : 距离开始
-5. **tipTextEnd** - 开始倒计时之后的提示文字
-    - **type**: String
-    - **required** : false
-    - **default** : 距离结束
-6. **endText** - 倒计时结束之后的提示文字
-    - **type**: String
-    - **required** : false
-    - **default** : 已结束
-7. **dayTxt** - 自定义显示的天数文字
-    - **type**: String
-    - **required** : false
-    - **default** : :
-8. **hourTxt** - 自定义显示的小时文字
-    - **type**: String
-    - **required** : false
-    - **default** : :
-9. **secondsTxt** - 自定义显示的分钟文字
-    - **type**: String
-    - **required** : false
-    - **default** : :
-10. **secondsFixed** - 自定义显示的秒数文字
-    - **type**: String
-    - **required** : false
-    - **default** : :
+**current-time**
+- `type`: Number
+- `required` : false
+- `default`: `new Date().getTime()`
+
+**start-time**
+- `type`: Number
+- `required` : true
+
+**end-time**
+- `type`: Number
+- `required` : true
+
+**tip-text**
+- `type`: String
+- `required` : false
+- `default` : '距离开始'
+
+**tip-text-end**
+- `type`: String
+- `required` : false
+- `default` : '距离结束'
     
+**end-text**
+- `type`: String
+- `required` : false
+- `default` : '已结束'
+
+**day-txt**
+- `type`: String
+- `required` : false
+- `default` : ':'
+    
+**hour-txt**
+- `type`: String
+- `required` : false
+- `default` : ':'
+
+**seconds-txt**
+- `type`: String
+- `required` : false
+- `default` : ':'
+
+**seconds-fixed**
+- `type`: String
+- `required` : false
+- `default` : ':'
+    
 ### Events
-1. **start_callback** - 开始倒计时结束之后的回调方法
-    - **type**: Function
-    - **required** : false
-2. **end_callback** - 活动倒计时结束之后的回调方法
-    - **type**: Function
-    - **required** : false
+**start_callback** - Event started callback
+- `type`: Function
+- `required` : false
+
+**end_callback** - Event ended callback
+- `type`: Function
+- `required` : false
     
@@ -136,0 +148,0 @@ # Liscense

No alert changes

Improved metrics

Total package byte prevSize

24215

increased by61.21%

Number of package files

6

increased by50%

Number of lines in readme file

147

increased by8.89%

No dependency changes