Skip to content

Commit

Permalink
Improved Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hfalucas committed Apr 10, 2019
1 parent 730ca7b commit 12df08d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
# vue-simplebar
# Vue Simplebar
Vue.js wrapper for simplebar

# Why would you use it ?

Because you want add [simplebar](https://github.com/Grsmto/simplebar) to your Vue project in an easy way, with the plus of having some usefull scroll events and helper methods out of the box.

If you have any reasonable PR you are welcome 🤘

# Install
## npm

Expand All @@ -32,7 +29,7 @@ import 'vue-simplebar/dist/vue-simplebar.css'
Vue.use(VueSimplebar)
```

Then use it like any other component in your app:
Then use it like any other component:

```html
<vue-simplebar>
Expand Down Expand Up @@ -79,7 +76,6 @@ export default {
# Props
#### `tag {String}`
Tag which will be render as perfect scrollbar container
Expand Down Expand Up @@ -121,3 +117,11 @@ infinite scroll).
<p> Your scrollable content goes here. </p>
</vue-simplebar>
```
# Contribution
If you have any reasonable PR you are welcome.
# License
[MIT](http://opensource.org/licenses/MIT)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vue-simplebar",
"version": "0.1.1",
"version": "0.1.2",
"description": "Vue.js wrapper for simplebar",
"paths": {
"source": "src",
Expand Down

0 comments on commit 12df08d

Please sign in to comment.