Skip to content

Commit 5a8c20d

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

File tree

1 file changed

+9
-22
lines changed

1 file changed

+9
-22
lines changed

README.md

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,7 @@
1-
<p align="center">
2-
<a href="#"><img src="https://raw.githubusercontent.com/coderdiaz/vue-template-plugin/master/logotype.png" width="380"></a>
3-
<h4 align="center">A Vue component for create a tiny pagination with Flexbox</h4>
4-
</p>
1+
# [Tiny Pagination](https://github.com/coderdiaz/vue-tiny-pagination) &middot; [![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)
2+
A Vue component for create a tiny paginate
53

6-
<p align="center">
7-
<a href="https://npmjs.com/package/vue-tiny-pagination"><img src="https://img.shields.io/npm/dt/vue-tiny-pagination.svg?style=flat-square"></a>
8-
<a href="https://github.com/coderdiaz/vue-tiny-pagination/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square"></a>
9-
<a href="https://github.com/coderdiaz/vue-tiny-pagination/stargazers"><img src="https://img.shields.io/github/stars/coderdiaz/vue-tiny-pagination.svg?style=flat-square"></a>
10-
<a href="http://npmjs.com/package/vue-tiny-pagination"><img src="https://img.shields.io/npm/v/vue-tiny-pagination.svg?style=flat-square"></a>
11-
<a href="http://npmjs.com/package/vue-tiny-pagination"><img src="https://img.shields.io/npm/dm/vue-tiny-pagination.svg?style=flat-square"></a>
12-
<a href="https://travis-ci.org/coderdiaz/vue-tiny-pagination"><img src="https://travis-ci.org/coderdiaz/vue-tiny-pagination.svg?branch=master&style=flat-square"></a>
13-
</p>
14-
15-
---
16-
17-
## Install/Usage
4+
# Install/Usage
185
<!-- Replace the docs for usage the plugin -->
196
```sh
207
# Install with npm
@@ -64,7 +51,7 @@ import { TinyPagination } from 'vue-tiny-pagination';
6451
Vue.component('custom-name', TinyPagination);
6552
```
6653

67-
### Usage in browser
54+
## Usage in browser
6855
<!-- Write an example for use the plugin in browser from CDN -->
6956
In browser you can use Unpkg, Jsdelivr, CDN.js, etc.
7057
```sh
@@ -75,9 +62,9 @@ https://unpkg.com/vue-tiny-pagination@latest/dist/vue-tiny-pagination.js
7562
https://cdn.jsdelivr.net/npm/vue-tiny-pagination@latest/dist/vue-tiny-pagination.min.js
7663
```
7764

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

90-
### Events
77+
## Events
9178
|Event|Description|
9279
|---|---|
9380
|tiny:change-page|Get the current page from pagination `payload: { page: 1 }`|
9481
|tiny:change-limit|Get the current limit from pagination `payload: { limit: 1 }`|
9582

96-
## Community
83+
# Community
9784
All feedback and suggestions are welcome!
9885

99-
## License
86+
# License
10087
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)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy