chore: readme improvements

Author: pikax

packages/vue-composable/README.md

@@ -14,6 +14,13 @@
 
 100% typescript based composable components and full type support out-of-box.
 
+This library aim is to be one stop shop for many real-world composable functions, with aggressive tree-shaking to keep it light on your end code ([12kb gzip](https://app.circleci.com/jobs/github/pikax/vue-composable/318/parallel-runs/0/steps/0-105)).
+
+[vue-composable](https://www.npmjs.com/package/vue-composable) is composed by two package [@vue-composable/core](./packages/core) and [@vue-composable/web](./packages/web).
+
+- [@vue-composable/core](./packages/core): contains helpers composables, such as Promise and Pagination.
+- [@vue-composable/web](./packages/web): contains [Web API](https://developer.mozilla.org/en-US/docs/Web/API) implementations
+
 ## Installing
 
 ```bash
@@ -119,6 +126,16 @@ export default {
 
 ## Contributing
 
+You can contribute raising issues and by helping out with code.
+
+Tests and Documentation are the most important things for me, because good documentation is really useful!
+
+I really appreciate some tweaks or changes on how the documentation is displayed and how to make it easier to read.
+
+> I really need an logo for this project, if you have a good idea for a logo, please enter in contact with me, you can find me on the `Vue discord : @pikax`
+
+### New composable
+
 1. Fork it!
 2. Create your feature branch: `git checkout -b feat/new-composable`
 3. Commit your changes: `git commit -am 'feat(composable): add a new composable'`

readme.md

@@ -10,6 +10,17 @@
 
 100% typescript based composable components and full type support out-of-box.
 
+This library aim is to be one stop shop for many real-world composable functions, with aggressive tree-shaking to keep it light on your end code ([12kb gzip](https://app.circleci.com/jobs/github/pikax/vue-composable/318/parallel-runs/0/steps/0-105)).
+
+[vue-composable](https://www.npmjs.com/package/vue-composable) is composed by two package [@vue-composable/core](./packages/core) and [@vue-composable/web](./packages/web).
+
+- [@vue-composable/core](./packages/core): contains helpers composables, such as Promise and Pagination.
+- [@vue-composable/web](./packages/web): contains [Web API](https://developer.mozilla.org/en-US/docs/Web/API) implementations
+
+# Vue 3
+
+> ## Support for `vue@next` on [vue3 branch](https://github.com/pikax/vue-composable/tree/vue3)
+
 ## Installing
 
 ```bash
@@ -24,13 +35,64 @@ npm install @vue/composition-api vue-composable
 
 Check our [documentation](https://pikax.me/vue-composable/)
 
+### Composable
+
+### Event
+
+- [Event](https://pikax.me/vue-composable/composable/event/event) - Attach event listener to a DOM element
+- [Mouse Move](https://pikax.me/vue-composable/composable/event/onMoveMove) - Attach `mousemove` listener to a DOM element
+- [Resize](https://pikax.me/vue-composable/composable/event/onResize) - Attach `resize` listener to a DOM element
+- [Scroll](https://pikax.me/vue-composable/composable/event/onScroll) - Attach `scroll` listener to a DOM element
+
+### MISC
+
+- [localStorage](https://pikax.me/vue-composable/composable/misc/localStorage) - Reactive access to a `localStorage`
+- [matchMedia](https://pikax.me/vue-composable/composable/misc/matchMedia) - Reactive `matchMedia`
+- [breakpoint](https://pikax.me/vue-composable/composable/misc/breakpoint) - reactive `breakpoints` based on `window.innerWidth`
+
+### Pagination
+
+- [Pagination](https://pikax.me/vue-composable/composable/pagination/pagination) - Generic reactive pagination controls
+- [Array Pagination](https://pikax.me/vue-composable/composable/pagination/arrayPagination) - Array pagination
+
+### Promise
+
+- [Promise](https://pikax.me/vue-composable/composable/promise/promise) - `Promise` reactive resolve and reject
+- [Cancellable Promise](https://pikax.me/vue-composable/composable/promise/cancellablePromise) - Allow to cancel promises
+- [Retry](https://pikax.me/vue-composable/composable/promise/retry) - Provides functionality to retry `promise`
+
+### Web
+
+- [Fetch](https://pikax.me/vue-composable/composable/web/fetch) - reactive `fetch` wrapper
+- [WebSocket](https://pikax.me/vue-composable/composable/web/webSocket) - reactive `WebSocket` wrapper
+- [IntersectionObserver](https://pikax.me/vue-composable/composable/web/intersectionObserver) - reactive `IntersectionObserver`
+- [NetworkInformation](https://pikax.me/vue-composable/composable/web/networkInformation) - reactive `NetworkInformation` wrapper
+- [Online](<[composable/web](https://pikax.me/vue-composable/composable/web)/online>) - reactive `navigator.onLine` wrapper
+- [PageVisibility](https://pikax.me/vue-composable/composable/web/pageVisibility) - reactive `Page Visibility API`
+- [Language](https://pikax.me/vue-composable/composable/web/language) - reactive `NavigatorLanguage`
+
+### External
+
+> New packages needed
+
+- [Axios](https://pikax.me/vue-composable/composable/external/axios) - [@vue-composable/axios](https://www.npmjs.com/package/@vue-composable/axios) reactive `axios` wrapper client
+
 ## Information
 
 This is a monorepo project, please check [packages](packages/) or check [vue-composable](packages/vue-composable)
 
-
 ## Contributing
 
+You can contribute raising issues and by helping out with code.
+
+Tests and Documentation are the most important things for me, because good documentation is really useful!
+
+I really appreciate some tweaks or changes on how the documentation is displayed and how to make it easier to read.
+
+> I really need an logo for this project, if you have a good idea for a logo, please enter in contact with me, you can find me on the `Vue discord : @pikax`
+
+### New composable
+
 1. Fork it!
 2. Create your feature branch: `git checkout -b feat/new-composable`
 3. Commit your changes: `git commit -am 'feat(composable): add a new composable'`