Merge pull request #2 from srav001/0.0.4

0.0.4

Author: srav001

.prettierrc.js renamed to .prettierrc.cjs

@@ -1,28 +1,26 @@
 # vue-subscription
 
+A type-safe 🔥, tiny ⭐️ &  fast ⚡️ replacement for EventBus in Vue 💚. Provides ESM and Common JS exports. Compatible with Vue versions `>=2.7.0` or `3.0.0`.
+
 This Vue package provides a simple way to create reactive subscriptions that can be used to observe changes to a value and execute a list of subscribers when the value changes. It also includes methods to mutate the value and trigger subscribers manually.
 
 The `useSubscription` function takes an initial value and returns an object with a reactive value of the initial value passed in, and a subscriber can be added to be executed when the value is changed.
 
----
-
 ## Installation and Import
 
 To use this package, you can install it via npm:
 
 ```sh
 // In your console
-npm install @vue-subscription
+npm install vue-subscription
 ```
 
 ```typescript
 // In your file
-import { useSubscription } from '@vue-subscription';
+import { useSubscription } from 'vue-subscription';
 const $mySubscription = useSubscription('hello'); // Type will be string
 ```
 
----
-
 ## API
 
 ### $value / $get()
@@ -98,8 +96,6 @@ subscription.$mutate(value => {
 });
 ```
 
----
-
 ## Usage
 
 ### Basic Example
@@ -202,8 +198,6 @@ $set(val => `Hello ${val}`);
 console.log($read.value); // 'Hello world'
 ```
 
----
-
 ## Type definition
 
 ### Function Signature
@@ -239,3 +233,8 @@ An object with the following properties:
 - $deleteSub(subscriber: (value: T) => Promise<void> | void)) - A method for removing a subscriber from the subscription.
 - $triggerSubs() - A method for manually triggering all subscribers. This should rarely be necessary.
 - $mutate(mutator: (value: T) => T) - A method for updating the value of the subscription with a function that takes the current value as its argument and returns the new value. This should only be used for updating complex objects.
+
+## DEMO
+
+You can checkout the demo to test locally or on StackBlitz
+https://github.com/srav001/vue-subscription/tree/main/demo

README.md

@@ -1,55 +1,69 @@
 {
-	"name": "vue-subscription",
-	"version": "0.0.1",
-	"description": "A simple ⭐️ & type-safe 🔥 replacement for EventBus in Vue 💚.",
-	"main": "index.js",
-	"scripts": {
-		"dev": "vite",
-		"preview": "vite preview",
-		"build-only": "vite build",
-		"type-check": "vue-tsc --noEmit",
-		"build": "pnpm type-check && pnpm build-only",
-		"pre-push": "pnpm format && pnpm lint && pnpm build",
-		"lint": "node -e 'require(\"./scripts\").lint()'",
-		"format": "node -e 'require(\"./scripts\").format()'",
-		"project-setup": "node -e 'require(\"./scripts\").projectSetup()'"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/srav001/vue-subscription.git"
-	},
-	"author": "",
-	"license": "MIT",
-	"bugs": {
-		"url": "https://github.com/srav001/vue-subscription/issues"
-	},
-	"homepage": "https://github.com/srav001/vue-subscription#readme",
-	"peerDependencies": {
-		"vue": ">=^2.7.0 || ^3.0.0"
-	},
-	"devDependencies": {
-		"@commitlint/cli": "^17.4.4",
-		"@commitlint/config-conventional": "^17.4.4",
-		"@types/node": "^18.14.2",
-		"@total-typescript/ts-reset": "^0.3.7",
-		"@typescript-eslint/eslint-plugin": "^5.54.0",
-		"@typescript-eslint/parser": "^5.54.0",
-		"@vitejs/plugin-vue": "^4.0.0",
-		"@vue/eslint-config-prettier": "^7.1.0",
-		"@vue/eslint-config-typescript": "^11.0.2",
-		"@vue/tsconfig": "^0.1.3",
-		"eslint": "^8.34.0",
-		"eslint-plugin-sonarjs": "^0.18.0",
-		"eslint-plugin-vue": "^9.9.0",
-		"husky": "^8.0.3",
-		"prettier": "^2.8.4",
-		"typescript": "~4.9.4",
-		"vite": "^4.1.4",
-		"vue": "^3.2.47",
-		"vue-tsc": "^1.2.0"
-	},
-	"engines": {
-		"node": ">=16.0.0",
-		"pnpm": ">=6.0.0"
-	}
-}
+  "name": "vue-subscription",
+  "version": "0.0.4",
+  "description": "A simple ⭐️ & type-safe 🔥 replacement for EventBus in Vue 💚.",
+  "scripts": {
+    "dev": "vite",
+    "preview": "vite preview",
+    "build-only": "vite build",
+    "type-check": "vue-tsc --noEmit",
+    "lint": "node -e 'require(\"./scripts.cjs\").lint()'",
+    "format": "node -e 'require(\"./scripts.cjs\").format()'",
+    "build": "pnpm type-check && pnpm build-only",
+    "pre-push": "pnpm format && pnpm lint && pnpm build",
+    "release": "node -e 'require(\"./scripts.cjs\").release()'",
+    "project-setup": "node -e 'require(\"./scripts.cjs\").projectSetup()'"
+  },
+  "type": "module",
+  "main": "./dist/vue-subscription.umd.cjs",
+  "module": "./dist/vue-subscription.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/vue-subscription.js",
+      "require": "./dist/vue-subscription.umd.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/srav001/vue-subscription.git"
+  },
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/srav001/vue-subscription/issues"
+  },
+  "homepage": "https://github.com/srav001/vue-subscription#readme",
+  "peerDependencies": {
+    "vue": ">=^2.7.0 || ^3.0.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.4.4",
+    "@commitlint/config-conventional": "^17.4.4",
+    "@total-typescript/ts-reset": "^0.3.7",
+    "@types/node": "^18.14.2",
+    "@typescript-eslint/eslint-plugin": "^5.54.0",
+    "@typescript-eslint/parser": "^5.54.0",
+    "@vitejs/plugin-vue": "^4.0.0",
+    "@vue/eslint-config-prettier": "^7.1.0",
+    "@vue/eslint-config-typescript": "^11.0.2",
+    "@vue/tsconfig": "^0.1.3",
+    "eslint": "^8.34.0",
+    "eslint-plugin-sonarjs": "^0.18.0",
+    "eslint-plugin-vue": "^9.9.0",
+    "husky": "^8.0.3",
+    "prettier": "^2.8.4",
+    "typescript": "~4.9.4",
+    "vite": "^4.1.4",
+    "vite-plugin-dts": "^2.1.0",
+    "vue": "^3.2.47",
+    "vue-tsc": "^1.2.0"
+  },
+  "engines": {
+    "node": ">=16.0.0",
+    "pnpm": ">=6.0.0"
+  }
+}