chore: releasing version 0.0.4

Author: srav001

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-subscription",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "A simple ⭐️ & type-safe 🔥 replacement for EventBus in Vue 💚.",
   "scripts": {
     "dev": "vite",

scripts/release/index.cjs

@@ -6,10 +6,13 @@ async function gitUpdate() {
 		const releaseData = JSON.parse(fs.readFileSync(releaseFile, { encoding: 'utf8' }));
 		const version = releaseData.version;
 
+		releaseData.onGoing = false;
+		fs.writeFileSync(releaseFile, JSON.stringify(releaseData, null, 2));
+
 		execWithSync(`git add .`);
 		execWithSync(`git commit -m "chore: releasing version ${version}"`);
 		execWithSync(`git tag ${version}`);
-		// execWithSync(`git push origin ${version}`);
+		execWithSync(`git push origin ${version}`);
 
 		return true;
 	} catch (e) {
@@ -19,14 +22,10 @@ async function gitUpdate() {
 
 async function npmRelease() {
 	try {
-		const releaseFile = path.resolve('scripts/release/releaseData.json');
-		const releaseData = JSON.parse(fs.readFileSync(releaseFile, { encoding: 'utf8' }));
-
 		execWithSync(`npm version`);
 		execWithSync(`npm publish`);
 
-		releaseData.onGoing = false;
-		return fs.writeFileSync(releaseFile, JSON.stringify(releaseData, null, 2));
+		return true;
 	} catch (e) {
 		console.error(e);
 	}

scripts/release/releaseData.json

@@ -1,4 +1,4 @@
 {
-  "onGoing": true,
-  "version": "0.0.3"
+  "onGoing": false,
+  "version": "0.0.4"
 }

src/subscription.ts

@@ -2,10 +2,11 @@ import { dynamicallyExecuteFunction } from './functions/helpers';
 import { ref, shallowRef, readonly } from 'vue';
 
 /**
- * It takes a value and returns an object with a value property that is a shallowRef of the value.
+ * It takes a value and returns an object with a value property that is a shallowRef/ref of the value.
  * passed in, and Subscribers(function) are added to a list to be executed when the value is changed.
  * @param {T} value - T - The initial value of the subscription.
- * @returns A function that returns an object with a shallow reactive value, a subscriber and a
+ * @param {boolean} deep - T - If it should be deep reactivity. By default it is Shallow.
+ * @returns A function that returns an object with a shallow/deep reactive value, a subscriber and a
  * few extra methods.
  */
 export function useSubscription<T>(value: T, deep = false) {