Skip to content

Commit 969e55f

Browse files
committed
add npmignore
update README.md
1 parent 8cef62d commit 969e55f

File tree

5 files changed

+31
-23
lines changed

5 files changed

+31
-23
lines changed

.npmignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
build
2+
src
3+
config
4+
static
5+
.babelrc
6+
.gitignore
7+
yarn.lock
8+
test
9+
index.html

README.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,29 @@
11
# vue-button
22

3-
> Button component for Vue.js
3+
> Button component for Vue.js v2.0.1+.
44
5-
## Install / Usage
6-
7-
NPM Based WorkFlows
5+
## Installation
86

7+
### NPM (Recommended)
98
``` bash
109
$ npm install vue-button
1110
```
12-
11+
### manual
12+
Just download `dist/vue-button.js` and include it in your HTML file:
1313
```html
14-
<template>
15-
<div id="my-app">
16-
<v-button>
17-
Hello
18-
</v-button>
19-
</div>
20-
</template>
21-
22-
<script>
14+
<script src="path/to/vue-button/dist/vue-button.js"></script>
15+
```
16+
## Usage
17+
```html
18+
<v-button>
19+
Hello
20+
</v-button>
21+
```
22+
## ES Modules with NPM & vue-loader (Recommended)
23+
```js
24+
import Vue from 'Vue'
2325
import VueButton from 'vue-button'
24-
export default {
25-
components: {
26-
VueButton
27-
}
28-
}
29-
</script>
26+
27+
// register component to use
28+
Vue.component('v-button', VueButton)
3029
```

build/build.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ console.log(
1818
var spinner = ora('building for production...')
1919
spinner.start()
2020

21-
var assetsPath = path.join(config.build.assetsRoot, config.build.assetsSubDirectory)
21+
var assetsPath = path.join(config.build.assetsRoot)
2222
rm('-rf', assetsPath)
2323
mkdir('-p', assetsPath)
2424

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "vue-button",
3-
"version": "0.0.10",
4-
"description": "Button component for Vue.js",
3+
"version": "0.0.12",
4+
"description": "> Button component for Vue.js v2.0.1+.",
55
"author": "steven5538 <steven5538@gmail.com>",
66
"keywords": [
77
"vue",

static/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)