docs: updated documentation

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+## Contribute
+We would love for you to contribute and help make it even better than it is todat! As a contributor, here are the guidelines we would like you to follow:
+
+## Development Setup
+You will need Node.js version +8.9.0.
+1. After clonning the repo, run:
+```bash
+$ npm i # or yarn install
+```
+
+### Commonly use NPM scripts
+```bash
+# build all packages
+$ npm run build
+
+# run full unit-tests suite
+$ npm run test:unit
+
+# run linter
+$ npm run lint
+```
+
+## Found a Bug?
+If you find a bug in source code, you can help us by submitting an issue to our GitHub repository. Even better, you can submit a Pull Request with a fix.
+
+## Missing a Feature?
+You can request a new feature by submitting an issue to our GitHub repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:
+- For a **Major Feature**, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted in the project. For your issue name, please prefix your proposal with `[discussion]`, for example "[discussion]: your feature idea".
+- **Small Features** can be crafted and firectly submitted as a Pull Request.
+
+## Coding Rules
+To ensure consistency throughout the source code, keep these rules in mind as you are working:
+- All feature or bug fixes **must be tested** by one or more specs (unit-tests).
+- We follow [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript), but wrap all code at **100 characters**.
+
+## Commit Message Guidelines
+We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**. But also, we use git commit messages to **generate the change log**.
+
+### Type
+Must be one of the following:
+- **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm).
+- **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs).
+- **docs**: Documentation only changes.
+- **feature**: A new feature.
+- **bugfix**: A bug fix.
+- **refactor**: A code change that neither fixes a bug nor adds a feature.
+- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
+- **test**: Adding missing tests or correcting existing tests.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018-2019 Javier Diaz Chamorro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,100 @@
+<p align="center">
+  <a href="#"><img src="logotype.png" width="380"></a>
+  <h4 align="center">A Vue component for create a tiny pagination with Flexbox</h4>
+</p>
+
+<p align="center">
+    <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>
+    <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>
+    <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>
+    <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>
+    <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>
+    <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>
+</p>
+
+---
+
+## Install/Usage
+<!-- Replace the docs for usage the plugin -->
+```sh
+# Install with npm
+$ npm i -S vue-tiny-pagination
+
+# or yarn
+$ yarn add vue-tiny-pagination
+```
+
+```html
+<div id="app">
+  <tiny-pagination
+    :total="currentTotal"
+    @tiny:change-page="changePage" />
+</div>
+```
+
+You can use **Local Registration**:
+```js
+import { TinyPagination } from 'vue-tiny-pagination';
+new Vue({
+  el: '#app',
+  data() {
+    return {
+      currentTotal: 100,
+      currentPage: 1,
+    };
+  },
+  methods: {
+    changePage (pagination) {
+      this.currentPage = pagination.page;
+    },
+  },
+  components: {
+    TinyPagination,
+  },
+});
+```
+
+or **Global Registration**:
+```js
+import TinyPagination from 'vue-tiny-pagination';
+Vue.use(TinyPagination);
+
+// or with a custom component name
+import { TinyPagination } from 'vue-tiny-pagination';
+Vue.component('custom-hello-world', TinyPagination);
+```
+
+### Usage in browser
+<!-- Write an example for use the plugin in browser from CDN -->
+In browser you can use Unpkg, Jsdelivr, CDN.js, etc.
+```sh
+# Unpkg
+https://unpkg.com/vue-tiny-pagination@latest/dist/vue-tiny-pagination.js
+
+# JSDelivr
+https://cdn.jsdelivr.net/npm/vue-tiny-pagination@latest/dist/vue-tiny-pagination.min.js
+```
+
+## Documentation
+<!-- Add all documentation about the plugin: props, events, etc -->
+### Props
+|Name|Description|Type|Default|Required|
+|---|---|---|---|---|
+|total|A number of total items|Number|-|true|
+|page|Prop to set a default page|Number|1|false|
+|lang|Default language to show (Available: en, es)|String|en|false|
+|customClass|Prop to set a custom class.|String|""|false|
+|limits|Prop to set a default limits to page sizes.|Array|[10, 15, 20,50,100]|false|
+|showLimit|Prop to disable the limit selector|Boolean|true|false|
+
+### Events
+|Event|Description|
+|---|---|
+|tiny:change-page|Get the current page from pagination `payload: { page: 1 }`|
+|tiny:change-limit|Get the current limit from pagination `payload: { limit: 1 }`|
+
+## Community
+All feedback and suggestions are welcome!
+
+## License
+This is a open-source software licensed under the [MIT license](https://raw.githubusercontent.com/coderdiaz/vue-tiny-pagination/master/LICENSE)