balm-scroll - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

package.json

 {
   "name": "balm-scroll",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Smooth scrolling for Vue.js",
@@ -44,4 +44,4 @@ "keywords": [
     "babel-eslint": "^10.0.2",
-    "balm": "^1.5.8",
-    "balm-ui": "^3.0.0",
+    "balm": "^1.6.0",
+    "balm-ui": "^3.0.1",
     "eslint": "^6.0.1",
@@ -48,0 +48,0 @@ "eslint-config-prettier": "^6.0.0",

README.md

 # Balm Scroll
 
-> Smooth scrolling for Vue.js
+## What is BalmScroll?
 
-## 0. What is BalmScroll?
+iScroll based, smooth scrolling for Vue.js
 
-iScroll + Vue.js
+## Quick Start
 
-## 1. Usage
+### 0. Requirement
 
-### 1.1 Css (Edit `my-project/app/styles/global/_vendor.scss`)
+- [BalmJS](https://balmjs.com/)(Recommended) or other toolchains
+- [Vue.js](https://vuejs.org/)@2.1.0+
 
+### 1. Install
+
+```sh
+npm i --save balm-scroll
+# OR
+yarn add balm-scroll
+```
+
+### 2. Usage
+
+#### 2.1 Css (Edit `my-project/app/styles/global/_vendor.scss`)
+
 ```css
-@import 'node_modules/balm-scroll/src/styles/balm-scroll.scss';
+@import 'node_modules/balm-scroll/dist/sass/balm-scroll.scss';
 ```
 
-### 1.2 Js (Edit `my-project/app/scripts/main.js`)
+#### 2.2 Js (Edit `my-project/app/scripts/main.js`)
 
@@ -26,3 +39,3 @@ ```js
 
-### 1.3 Vue (Edit a vue component: `my-project/app/scripts/views/demos/hello.vue`)
+#### 2.3 Vue (Edit a vue component: `my-project/app/scripts/views/demos/hello.vue`)
 
@@ -49,5 +62,5 @@ ```html
 
-## 2. Configuring
+### 3. Configuring
 
-### 2.1 The many faces of [iScroll](https://github.com/cubiq/iscroll/#the-many-faces-of-iscroll)
+#### 3.1 The many faces of [iScroll](https://github.com/cubiq/iscroll/#the-many-faces-of-iscroll)
 
@@ -62,9 +75,9 @@ - `<ui-scroll>`
 
-### 2.2 Options
+#### 3.2 Options
 
 - See [here](https://github.com/cubiq/iscroll/#configuring-the-iscroll)
 
-## 3. Props, Slots and Events
+### 4. Props, Slots and Events
 
-### 3.1 Props
+#### 4.1 Props
 
@@ -103,3 +116,3 @@ | Name               | Type       | Default                  | Description          |
 
-### 3.2 Slots
+#### 4.2 Slots
 
@@ -116,3 +129,3 @@ | Name               | Description                                        |
 
-## 4. Special Thanks to
+## Special Thanks to
 
@@ -119,0 +132,0 @@ - [BalmJS](https://balmjs.com/)

No alert changes

Improved metrics

Total package byte prevSize

354691

increased by0.56%

Number of package files

14

increased by16.67%

Number of lines in readme file

130

increased by11.11%

No dependency changes