Skip to content

Commit 6585b14

Browse files
committed
feat: added licence and readme
1 parent b2d2a0a commit 6585b14

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

LICENSE

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

readme.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# vue-composable
2+
3+
[![CircleCI](https://circleci.com/gh/pikax/vue-composable.svg?style=svg)](https://circleci.com/gh/pikax/vue-composable)
4+
[![Coverage Status](https://coveralls.io/repos/github/pikax/vue-composable/badge.svg?branch=master)](https://coveralls.io/github/pikax/vue-composable?branch=master)
5+
6+
## Introduction
7+
8+
`vue-composable` is out-of-box ready to use [composition-api](https://github.com/vuejs/composition-api) generic components, eg: [usePromise](src/promise.ts)
9+
10+
11+
| composable | description | arguments | return |
12+
|---|---|---|---|
13+
| [useArrayPagination](src/arrayPagination.ts) | provides pagination for an array | | |
14+
| [useDebounce](src/useDebounce.ts) | debounces function | | |
15+
| [useEvent](src/useEvent.ts) | handles the lifecycle of addEventListener/removeEventListener for a component. | | |
16+
| [useOnMouseMove](src/useOnMouseMove.ts) | gets data from element `movemove` | | |
17+
| [useOnResize](src/useOnResize.ts) | gets data from element `resize` | | |
18+
| [useOnScroll](src/useOnScroll.ts) | gets data from element `scroll` | | |
19+
| [usePagination](src/usePagination.ts) | provides pagination controls. *NOTE: base type* | | |
20+
| [usePromise](src/usePromise.ts) | provides information about the state of the promise | | |
21+
22+
23+
## Types
24+
25+
26+
27+
28+
## License
29+
30+
[MIT](http://opensource.org/licenses/MIT)

0 commit comments

Comments
 (0)