chore: version and readme tweaks

Author: Carlos Rodrigues

package.json

@@ -1,12 +1,19 @@
 {
   "name": "vue-composable",
-  "version": "1.0.0",
-  "description": "Vue composition api helpers",
+  "version": "0.1.0",
+  "description": "Vue composition-api composable components",
   "main": "index.js",
-  "author": "pikax",
+  "author": {
+    "name": "pikax",
+    "email": "[email protected]"
+  },
   "license": "MIT",
-  "module": "dist/vue-composable.es5.js",
-  "typings": "dist/types/vue-composable.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pikax/vue-composable.git"
+  },
+  "module": "dist/vue-composable.es.js",
+  "typings": "dist/index.d.ts",
   "files": [
     "dist"
   ],
@@ -19,13 +26,18 @@
     "test:watch": "jest --coverage --watch",
     "test:prod": "npm run lint && npm run test -- --no-cache"
   },
-  "dependencies": {
+  "bugs": {
+    "url": "https://github.com/pikax/vue-composable/issues"
+  },
+  "homepage": "https://github.com/pikax/vue-composable/blob/master/readme.md",
+  "peerDependencies": {
     "@vue/composition-api": "^0.3.2",
     "vue": "^2.6.10"
   },
   "devDependencies": {
     "@types/jest": "^24.0.19",
     "@types/node": "^12.11.5",
+    "@vue/composition-api": "^0.3.2",
     "coveralls": "^3.0.7",
     "jest": "^24.9.0",
     "jest-junit": "^9.0.0",
@@ -40,6 +52,7 @@
     "rollup-plugin-terser": "^5.1.2",
     "rollup-plugin-typescript2": "^0.24.3",
     "ts-jest": "^24.1.0",
-    "typescript": "^3.6.4"
+    "typescript": "^3.6.4",
+    "vue": "^2.6.10"
   }
 }

readme.md

@@ -5,20 +5,24 @@
 
 ## Introduction
 
-`vue-composable` is out-of-box ready to use [composition-api](https://github.com/vuejs/composition-api) generic components, eg: [usePromise](src/promise.ts)
+`vue-composable` is out-of-box ready to use [composition-api](https://github.com/vuejs/composition-api) generic components, eg: [useFetch](examples/fetch.html)
 
 
-| composable | description | arguments | return |
+## NOTE 
+Currently only works with [composition-api](https://github.com/vuejs/composition-api), when [Vue3](https://github.com/vuejs/vue-next) gets release I will update to use the new reactive system (using [@vue/reactivity](https://github.com/vuejs/vue-next/tree/master/packages/reactivity))
+
+
+| composable | description | example | extra |
 |---|---|---|---|
-| [useArrayPagination](src/arrayPagination.ts) | provides pagination for an array |  |  |
+| [useArrayPagination](src/arrayPagination.ts) | provides pagination for an array | [arrayPagination.html](examples/arrayPagination.html) |  |
 | [useDebounce](src/debounce.ts) | debounces function |  |  |
 | [useEvent](src/event.ts) | handles the lifecycle of addEventListener/removeEventListener for a component. |  |  |
 | [useOnMouseMove](src/onMouseMove.ts) | gets data from element `movemove` |  |  |
 | [useOnResize](src/onResize.ts) | gets data from element `resize` |  |  |
 | [useOnScroll](src/onScroll.ts) | gets data from element `scroll` |  |  |
 | [usePagination](src/pagination.ts) | provides pagination controls. *NOTE: base type*  |  |  |
 | [usePromise](src/promise.ts) | provides information about the state of the promise |  |  |
-| [useFetch](src/fetch.ts) | handles the fetch request |  |  |
+| [useFetch](src/fetch.ts) | handles the fetch request | [fetch.html](examples/fetch.html) |  |
 
 
 ## Types