Skip to content

Commit 1e6f082

Browse files
author
Javier Diaz
committed
docs: updated readme.md
1 parent 5a8c20d commit 1e6f082

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# [Tiny Pagination](https://github.com/coderdiaz/vue-tiny-pagination) · [![NPMVERSION](https://img.shields.io/npm/v/vue-tiny-pagination.svg?style=flat-square)](http://npmjs.com/package/vue-tiny-pagination) [![GITHUBSTARS](https://img.shields.io/github/stars/coderdiaz/vue-tiny-pagination.svg?style=flat-square)](https://github.com/coderdiaz/vue-tiny-pagination/stargazers) [![BUILD](https://travis-ci.org/coderdiaz/vue-tiny-pagination.svg?branch=master&style=flat-square)](https://travis-ci.org/coderdiaz/vue-tiny-pagination) [![DOWNLOADS](https://img.shields.io/npm/dt/vue-tiny-pagination.svg?style=flat-square)](https://npmjs.com/package/vue-tiny-pagination)
22
A Vue component for create a tiny paginate
33

4-
# Install/Usage
4+
## Install/Usage
55
<!-- Replace the docs for usage the plugin -->
66
```sh
77
# Install with npm
@@ -51,7 +51,7 @@ import { TinyPagination } from 'vue-tiny-pagination';
5151
Vue.component('custom-name', TinyPagination);
5252
```
5353

54-
## Usage in browser
54+
### Usage in browser
5555
<!-- Write an example for use the plugin in browser from CDN -->
5656
In browser you can use Unpkg, Jsdelivr, CDN.js, etc.
5757
```sh
@@ -62,9 +62,9 @@ https://unpkg.com/vue-tiny-pagination@latest/dist/vue-tiny-pagination.js
6262
https://cdn.jsdelivr.net/npm/vue-tiny-pagination@latest/dist/vue-tiny-pagination.min.js
6363
```
6464

65-
# Documentation
65+
## Documentation
6666
<!-- Add all documentation about the plugin: props, events, etc -->
67-
## Props
67+
### Props
6868
|Name|Description|Type|Default|Required|
6969
|---|---|---|---|---|
7070
|total|A number of total items|Number|-|true|
@@ -74,14 +74,14 @@ https://cdn.jsdelivr.net/npm/vue-tiny-pagination@latest/dist/vue-tiny-pagination
7474
|limits|Prop to set a default limits to page sizes.|Array|[10, 15, 20,50,100]|false|
7575
|showLimit|Prop to disable the limit selector|Boolean|true|false|
7676

77-
## Events
77+
### Events
7878
|Event|Description|
7979
|---|---|
8080
|tiny:change-page|Get the current page from pagination `payload: { page: 1 }`|
8181
|tiny:change-limit|Get the current limit from pagination `payload: { limit: 1 }`|
8282

83-
# Community
83+
## Community
8484
All feedback and suggestions are welcome!
8585

86-
# License
86+
## License
8787
This is a open-source software licensed under the [MIT license](https://raw.githubusercontent.com/coderdiaz/vue-tiny-pagination/master/LICENSE)

0 commit comments

Comments
 (0)