Add missing license and readme

LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Robert Soriano
+
+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,79 @@
+# pinia-shared-state
+
+[![npm (tag)](https://img.shields.io/npm/v/pinia-shared-state?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/pinia-shared-state) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/pinia-shared-state?style=flat&colorA=000000&colorB=000000) ![NPM](https://img.shields.io/npm/l/pinia-shared-state?style=flat&colorA=000000&colorB=000000)
+
+Sync your Pinia state across browser tabs. Supports Vue 2 and 3.
+
+## Requirements
+
+- vue ^2.6.14 || ^3.2.0
+
+## Install
+
+```sh
+pnpm add pinia pinia-shared-state
+```
+
+## Usage
+
+```js
+import { PiniaSharedState } from 'pinia-shared-state';
+
+// Pass the plugin to your application's pinia plugin
+pinia.use(
+  PiniaSharedState({
+    // Enables the plugin for all stores. Defaults to true.
+    enable: true,
+    // If set to true this tab tries to immediately recover the shared state from another tab. Defaults to true.
+    initialize: false,
+    // Enforce a type. One of native, idb, localstorage or node. Defaults to native.
+    type: 'localstorage',
+  }),
+);
+```
+
+```js
+const useStore = defineStore({
+  id: 'counter',
+  state: () => ({
+    count: 0,
+    foo: 'bar',
+  }),
+  share: {
+    // An array of fields that the plugin will ignore.
+    omit: ['foo'],
+    // Override global config for this store.
+    enable: true,
+    initialize: true,
+  },
+});
+```
+
+Manual state sharing is also possible:
+
+```ts
+import { onMounted, onUnmounted } from 'vue';
+import { share, unshare } from 'pinia-shared-state';
+import useStore from './store';
+
+const counterStore = useStore();
+
+onMounted(() => {
+  share('counter', counterStore, { initialize: true });
+});
+
+onUnmounted(() => {
+  // Call `unshare` method to close the channel
+  unshare();
+});
+```
+
+## Credits
+
+- [pinia](https://pinia.esm.dev/) - 🍍 Intuitive, type safe, light and flexible Store for Vue using the composition api with DevTools support.
+- [vue-demi](https://github.com/vueuse/vue-demi/) - Creates Universal Library for Vue 2 & 3.
+- [broadcast-channel](https://github.com/pubkey/broadcast-channel) - BroadcastChannel to send data between different browser-tabs or nodejs-processes.
+
+## License
+
+[MIT License](http://opensource.org/licenses/MIT).