Skip to content

Commit 1ad98f6

Browse files
committed
update readme, add contributing
1 parent f384e86 commit 1ad98f6

File tree

1 file changed

+29
-20
lines changed

1 file changed

+29
-20
lines changed

README.md

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

3-
> Straightforward Vue button component with slideout loading indicator
3+
> Straightforward Vue button with slideout loading indicator
44
5-
[![Try it on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/4zywwyjxw7)
5+
![example use](https://user-images.githubusercontent.com/38357771/52435345-9fe26a00-2adf-11e9-832e-497ffa480d05.gif)
6+
7+
[![try it on codesandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/4zywwyjxw7)
68

79
## Props
810

@@ -13,7 +15,7 @@
1315

1416
## Installation
1517

16-
Install the package from npm by running
18+
Install the package from npm by running:
1719

1820
```
1921
$ npm i vue-loading-button
@@ -29,36 +31,43 @@ $ yarn add vue-loading-button
2931

3032
Import, register and place the component in your Vue app.
3133

32-
```
34+
```html
3335
<template>
34-
[...]
35-
<VueLoadingButton />
36-
[...]
36+
<VueLoadingButton />
3737
</template>
38+
```
3839

39-
<script>
40+
```js
4041
import VueLoadingButton from 'vue-loading-button'
4142

42-
[...]
43+
export default {
4344
components: {
4445
VueLoadingButton,
45-
[...]
46-
</script>
46+
}
47+
}
4748
```
4849

49-
## Dev
50-
51-
Running example script requires @vue/cli and @vue/cli-service-global to be installed.
52-
Install globally by running `npm i --g @vue/cli @vue/cli-service-global` or `yarn add global vue/cli @vue/cli-service-global`
53-
5450
## Accessibility
5551

5652
Apply attributes, such as aria-label, directly on the element to apply them to the button.
5753

58-
```
54+
```html
5955
<template>
60-
[...]
61-
<VueLoadingButton aria-label='Send message' />
62-
[...]
56+
<VueLoadingButton aria-label='Send message' />
6357
</template>
6458
```
59+
60+
## Dev
61+
62+
Running example script requires @vue/cli and @vue/cli-service-global to be installed.
63+
Install globally by running `npm i --g @vue/cli @vue/cli-service-global` or `yarn add global vue/cli @vue/cli-service-global`.
64+
65+
## Contributing
66+
67+
This project is open to and encourages contributions! Feel free to discuss any bug fixes/features in the [issues](https://github.com/shwilliam/vue-loading-button/issues). If you wish to work on this project:
68+
69+
1. [Fork the project](https://github.com/shwilliam/vue-loading-button/archive/master.zip)
70+
2. Create your feature branch (`git checkout -b new-feature-branch`)
71+
3. Commit your changes (`git commit -am 'add new feature'`)
72+
4. Push to the branch (`git push origin new-feature-branch`)
73+
5. [Submit a pull request!](https://github.com/shwilliam/vue-loading-button/pull/new/master)

0 commit comments

Comments
 (0)