@swaray21/date-utils 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,80 @@
+# Date Utils
+
+A lightweight JavaScript package that provides simple date and time utility functions.
+
+## Installation
+
+Install the package using npm:
+
+```bash
+npm install @swaray21/date-utils
+```
+
+## Usage
+
+Import the functions into your JavaScript project:
+
+```javascript
+const {
+    formatDate,
+    calculateAge,
+    getDaysBetween,
+    isWeekend,
+    addDays
+} = require("@swaray21/date-utils");
+```
+
+## Available Functions
+
+### 1. formatDate(date)
+
+Formats a date into DD/MM/YYYY.
+
+```javascript
+formatDate("2026-10-31");
+// Output: 31/10/2026
+```
+
+### 2. calculateAge(dateOfBirth)
+
+Calculates a person's age from their date of birth.
+
+```javascript
+calculateAge("2000-01-01");
+```
+
+### 3. getDaysBetween(startDate, endDate)
+
+Calculates the number of days between two dates.
+
+```javascript
+getDaysBetween("2026-10-01", "2026-10-31");
+// Output: 30
+```
+
+### 4. isWeekend(date)
+
+Checks whether a date falls on Saturday or Sunday.
+
+```javascript
+isWeekend("2026-10-31");
+// Output: true
+```
+
+### 5. addDays(date, days)
+
+Adds a specified number of days to a date.
+
+```javascript
+addDays("2026-10-31", 5);
+// Returns a Date object representing November 5, 2026.
+```
+
+## Requirements
+
+- Node.js
+- npm
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swaray21/date-utils",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A lightweight JavaScript date and time utility library",
   "main": "index.js",
   "type": "commonjs",
@@ -21,4 +21,4 @@
     "README.md",
     "LICENSE"
   ]
-}
+}