@parasrp/delay 1.0.1 → 1.1.0

package/README.md

@@ -1,19 +1,78 @@
 # @parasrp/delay
 
-A small and simple JavaScript utility to pause execution for a specified number of milliseconds.
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+![npm version](https://img.shields.io/npm/v/@parasrp/delay)
+![Size](https://img.shields.io/bundlephobia/min/@parasrp/delay)
+
+A lightweight, promise-based JavaScript utility to pause execution for a specified duration. Perfect for adding timeouts, staggering API calls, or building simple animations.
+
+---
 
 ## ✨ Features
 
-- Lightweight and fast
-- Promise-based
-- No dependencies
-- Works in any modern JavaScript environment
+- 🪶 **Lightweight & Fast**: Zero overhead, minimal footprint.
+- 🤝 **Promise-based**: Works seamlessly with `async/await`.
+- 📦 **Zero Dependencies**: Keeps your node_modules clean.
+- 🌍 **Universal**: Works in Node.js, browsers, and modern JS environments.
 
 ---
 
 ## 📦 Installation
 
-Install using npm:
-
+Install the package via npm:
 ```bash
 npm install @parasrp/delay
+```
+
+Install the package via yarn:
+```bash
+yarn add @parasrp/delay
+```
+---
+
+## ✨ Features
+You can use @parasrp/delay with both CommonJS and ES Modules.
+
+ES6 Modules:
+```js
+import delay from "@parasrp/delay";
+```
+
+CommonJS:
+```js
+const delay = require("@parasrp/delay");
+```
+
+---
+
+## Examples
+
+Using async/await:
+```js
+async function countdown() {
+  console.log("Starting countdown...");
+  
+  for (let i = 5; i > 0; i--) {
+    console.log(i);
+    await delay(1000); // Waits for 1 second
+  }
+  
+  console.log("Go!");
+}
+
+countdown();
+```
+
+Using .then():
+```js
+console.log("Start waiting...");
+
+delay(1000).then(() => {
+  console.log("Finished waiting 1000 milliseconds");
+});
+```
+
+## 👤 Author
+**Paras R Poshiya**
+* [GitHub](https://github.com/parasposhiya)
+* [GitLab](https://gitlab.com/parasposhiya)

package/package.json

@@ -1,16 +1,16 @@
-{
-  "name": "@parasrp/delay",
-  "version": "1.0.1",
-  "description": "sleep function",
-  "author": "Paras R Poshiya",
-  "keywords": [
-    "sleep",
-    "delay"
-  ],
-  "license": "MIT",
-  "main": "index.js",
-  "type": "module",
-  "exports": {
-    ".": "./index.js"
-  }
+{
+  "name": "@parasrp/delay",
+  "version": "1.1.0",
+  "description": "sleep function",
+  "author": "Paras R Poshiya",
+  "keywords": [
+    "sleep",
+    "delay"
+  ],
+  "license": "MIT",
+  "main": "index.js",
+  "type": "module",
+  "exports": {
+    ".": "./index.js"
+  }
 }