Skip to content

Commit 9aab54c

Browse files
committed
chore(docs): added contribute section to readme and missing composables
1 parent 3de17c8 commit 9aab54c

File tree

4 files changed

+52
-7
lines changed

4 files changed

+52
-7
lines changed

packages/axios/README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ npm install @vue/composition-api vue-composable @vue-composable/axios
2020

2121
Check our [documentation](https://pikax.me/vue-composable/composable/external/axios)
2222

23-
2423
```vue
2524
<template>
2625
<div>
@@ -63,4 +62,16 @@ export default {
6362
}
6463
};
6564
</script>
66-
```
65+
```
66+
67+
## Contributing
68+
69+
1. Fork it!
70+
2. Create your feature branch: `git checkout -b feat/new-composable`
71+
3. Commit your changes: `git commit -am 'feat(composable): add a new composable'`
72+
4. Push to the branch: `git push origin feat/new-composable`
73+
5. Submit a pull request
74+
75+
## License
76+
77+
[MIT](http://opensource.org/licenses/MIT)

packages/core/README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,21 @@ Check our [documentation](https://pikax.me/vue-composable/)
3939

4040
<!-- TODO SET CORRECT url -->
4141

42-
[pagination]: https://github.com/pikax/vue-composable
43-
[array-pagination]: https://github.com/pikax/vue-composable
44-
[promise]: https://github.com/pikax/vue-composable
45-
[retry]: https://github.com/pikax/vue-composable
46-
[cancellable-promise]: https://github.com/pikax/vue-composable
42+
[pagination]: https://pikax.me/vue-composable/composable/pagination/pagination
43+
[array-pagination]: https://pikax.me/vue-composable/composable/pagination/arrayPagination
44+
[promise]: https://pikax.me/vue-composable/composable/promise/promise
45+
[retry]: https://pikax.me/vue-composable/composable/promise/retry
46+
[cancellable-promise]: https://pikax.me/vue-composable/composable/promise/cancellablePromise
4747
[debounce]: https://github.com/pikax/vue-composable
48+
49+
## Contributing
50+
51+
1. Fork it!
52+
2. Create your feature branch: `git checkout -b feat/new-composable`
53+
3. Commit your changes: `git commit -am 'feat(composable): add a new composable'`
54+
4. Push to the branch: `git push origin feat/new-composable`
55+
5. Submit a pull request
56+
57+
## License
58+
59+
[MIT](http://opensource.org/licenses/MIT)

packages/vue-composable/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Check our [documentation](https://pikax.me/vue-composable/)
3434
### MISC
3535

3636
- [localStorage](https://pikax.me/vue-composable/composable/misc/localStorage) - Reactive access to a `localStorage`
37+
- [matchMedia](https://pikax.me/vue-composable/composable/misc/matchMedia) - Reactive `matchMedia`
38+
- [breakpoint](https://pikax.me/vue-composable/composable/misc/breakpoint) - reactive `breakpoints` based on `window.innerWidth`
3739

3840
### Pagination
3941

@@ -50,6 +52,7 @@ Check our [documentation](https://pikax.me/vue-composable/)
5052

5153
- [Fetch](https://pikax.me/vue-composable/composable/web/fetch) - reactive `fetch` wrapper
5254
- [WebSocket](https://pikax.me/vue-composable/composable/web/webSocket) - reactive `WebSocket` wrapper
55+
- [IntersectionObserver](https://pikax.me/vue-composable/composable/web/intersectionObserver) - reactive `IntersectionObserver`
5356

5457
### External
5558

@@ -104,6 +107,14 @@ export default {
104107
</script>
105108
```
106109

110+
## Contributing
111+
112+
1. Fork it!
113+
2. Create your feature branch: `git checkout -b feat/new-composable`
114+
3. Commit your changes: `git commit -am 'feat(composable): add a new composable'`
115+
4. Push to the branch: `git push origin feat/new-composable`
116+
5. Submit a pull request
117+
107118
## License
108119

109120
[MIT](http://opensource.org/licenses/MIT)

packages/web/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,22 @@ Check our [documentation](https://pikax.me/vue-composable/)
2828
### MISC
2929

3030
- [localStorage](https://pikax.me/vue-composable/composable/misc/localStorage) - Reactive access to a `localStorage`
31+
- [matchMedia](https://pikax.me/vue-composable/composable/misc/matchMedia) - Reactive `matchMedia`
32+
- [breakpoint](https://pikax.me/vue-composable/composable/misc/breakpoint) - reactive `breakpoints` based on `window.innerWidth`
3133

3234
### Web
3335

3436
- [Fetch](https://pikax.me/vue-composable/composable/web/fetch) - reactive `fetch` wrapper
3537
- [WebSocket](https://pikax.me/vue-composable/composable/web/webSocket) - reactive `WebSocket` wrapper
38+
- [IntersectionObserver](https://pikax.me/vue-composable/composable/web/intersectionObserver) - reactive `IntersectionObserver`
39+
40+
## Contributing
41+
42+
1. Fork it!
43+
2. Create your feature branch: `git checkout -b feat/new-composable`
44+
3. Commit your changes: `git commit -am 'feat(composable): add a new composable'`
45+
4. Push to the branch: `git push origin feat/new-composable`
46+
5. Submit a pull request
3647

3748
## License
3849

0 commit comments

Comments
 (0)