today-day 1.5.0 → 1.5.2

package/README.md

@@ -1,74 +1,106 @@
-# Project Title
+# today-day 📅
 
-Simple library to get today day.
+[![npm version](https://img.shields.io/npm/v/today-day.svg)](https://www.npmjs.com/package/today-day)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-## Description
+A simple, lightweight JavaScript library to quickly get the current day of the week, calculate future or past days, and generate random days. 
 
-When you dont know what day today, use this library.
+Whether you are working in Node.js or directly in the browser, `today-day` comes with built-in Internationalization (i18n) support, so you can easily localize your days without pulling in a massive date-formatting library like Moment.js.
 
-### Dependencies
+---
 
-- Node.js 4.9.1+
+## ✨ Features
 
-### Installing
+- **Lightweight & Fast:** Get the day of the week instantly without heavy date manipulation overhead.
+- **Time Travel:** Easily add or subtract days to find out what day it will be in the future or was in the past.
+- **Built-in i18n:** Native support for English (`en_US`), Hebrew (`he_IL`), and French (`fr_FR`).
+- **Universal:** Works seamlessly in Node.js (v4.9.1+) and directly in the browser via CDN.
+- **Fully Tested:** Backed by Jest to ensure rock-solid reliability.
 
-- npm i today-day
+---
 
-### Executing program
+## 📦 Installation
 
-- How to run the program
+**Using npm:**
+```bash
+npm install today-day
+```
 
+**Using a CDN (Browser):**
+```html
+<script src="[https://cdn.jsdelivr.net/npm/today-day@1.5.1/dist/today-day.min.js](https://cdn.jsdelivr.net/npm/today-day@1.5.1/dist/today-day.min.js)"></script>
 ```
-const todayDay = require('today-day')
 
-//Friday
-todayDay.today();
+---
 
-//Monday
-todayDay.random();
+## 🚀 Quick Start & API
 
-//Tuesday
-todayDay.addDays(4);
+### Basic Usage
 
-//Wednesday
-todayDay.addDays(-29);
+```javascript
+const todayDay = require('today-day');
 
+// Get the current day
+console.log(todayDay.today()); 
+// => "Friday"
 
-//set language to hebrew
-todayDay.locale('he_IL');
+// Get a completely random day of the week
+console.log(todayDay.random()); 
+// => "Monday"
+```
 
-//שישי
-todayDay.today();
+### Adding & Subtracting Days
+Need to know what day it will be in 4 days, or what day it was 29 days ago?
 
-//["en_US", "fr_FR", "he_IL"]
-todayDay.getSupportedLanguages();
+```javascript
+// 4 days from today
+console.log(todayDay.addDays(4)); 
+// => "Tuesday"
 
+// 29 days ago
+console.log(todayDay.addDays(-29)); 
+// => "Wednesday"
 ```
 
-- How to run tests
+### Localization (i18n)
+Easily switch between supported languages.
+
+```javascript
+// Set language to Hebrew
+todayDay.locale('he_IL');
+
+// Get today's day in Hebrew
+console.log(todayDay.today()); 
+// => "שישי"
+
+// See all currently supported language codes
+console.log(todayDay.getSupportedLanguages()); 
+// => ["en_US", "fr_FR", "he_IL"]
 ```
+
+---
+
+## 🧪 Testing
+
+This project uses Jest for testing. To run the test suite locally:
+
+```bash
 npm run test
 ```
 
-## i18n
-- English (en_US)
-- Hebrew (he_IL)
-- French (fr_FR)
-
-## Version History
-
-- 1.5.0
-  - Added browser Support
-- 1.2.0
-  - Algorithm Improvements
-  - Changed Languages object 
-- 1.1.2
-  - Added random function
-  - Added addDays function
-- 1.1.1
-  - Changed function name setLanguages to locale
-  - Removed todayUpperCase
-  - Removed todayLowerCase
-- 1.1.0
-  - Added Jest library for tests.
+---
+
+## 🤝 Contributing
+
+Contributions, issues, and feature requests are welcome! 
+
+1. Fork the project.
+2. Clone your fork.
+3. Install dependencies: `npm install`
+4. Make your changes and write tests if applicable.
+5. Ensure tests pass: `npm run test`
+6. Create a Pull Request!
+
+## 📝 License
 
+This project is [MIT](https://opensource.org/licenses/MIT) licensed.

package/index.js

@@ -1,58 +1,58 @@
-const languages = require('./languages');
-
-const supportedLanguage = ['en_US', 'fr_FR', 'he_IL'];
-let translateLanguage = languages.en_US;
-
-const privateMethods = {
-    getDay: (dayNumber) => {
-        const day = dayNumber !== undefined ? dayNumber : new Date().getDay();
-        return translateLanguage[day];
-    },
-
-    calculateAddedDays: (number) => {
-        return (new Date().getDay() + number) % 7;
-    },
-};
-
-const publicMethods = {
-    getSupportedLanguages: () => {
-        return supportedLanguage;
-    },
-
-    locale: (language) => {
-        if (language && supportedLanguage.includes(language)) {
-            translateLanguage = languages[language];
-        } else {
-            throw Error('Not supported language');
-        }
-    },
-
-    today: () => {
-        return privateMethods.getDay();
-    },
-
-    random: () => {
-        const randomDay = Math.floor(Math.random() * 6);
-        return privateMethods.getDay(randomDay);
-    },
-
-    addDays: (number) => {
-        let dayAfterAdded;
-        if (number !== undefined && !Number.isNaN(number)) {
-            let daysToAdd = number;
-            if (number < 0) {
-                daysToAdd = ((number % 7) + 7) % 7;
-            }
-            const dayToGet = privateMethods.calculateAddedDays(daysToAdd);
-            dayAfterAdded = privateMethods.getDay(dayToGet);
-        } else {
-            throw Error('Not a number!');
-        }
-        return dayAfterAdded;
-    },
-};
-
-module.exports = publicMethods;
-if (typeof window !== 'undefined') {
-    window.todayDay = publicMethods;
-}
+const languages = require('./languages');
+
+const supportedLanguage = ['en_US', 'fr_FR', 'he_IL'];
+let translateLanguage = languages.en_US;
+
+const privateMethods = {
+    getDay: (dayNumber) => {
+        const day = dayNumber !== undefined ? dayNumber : new Date().getDay();
+        return translateLanguage[day];
+    },
+
+    calculateAddedDays: (number) => {
+        return (new Date().getDay() + number) % 7;
+    },
+};
+
+const publicMethods = {
+    getSupportedLanguages: () => {
+        return supportedLanguage;
+    },
+
+    locale: (language) => {
+        if (language && supportedLanguage.includes(language)) {
+            translateLanguage = languages[language];
+        } else {
+            throw Error('Not supported language');
+        }
+    },
+
+    today: () => {
+        return privateMethods.getDay();
+    },
+
+    random: () => {
+        const randomDay = Math.floor(Math.random() * 6);
+        return privateMethods.getDay(randomDay);
+    },
+
+    addDays: (number) => {
+        let dayAfterAdded;
+        if (number !== undefined && !Number.isNaN(number)) {
+            let daysToAdd = number;
+            if (number < 0) {
+                daysToAdd = ((number % 7) + 7) % 7;
+            }
+            const dayToGet = privateMethods.calculateAddedDays(daysToAdd);
+            dayAfterAdded = privateMethods.getDay(dayToGet);
+        } else {
+            throw Error('Not a number!');
+        }
+        return dayAfterAdded;
+    },
+};
+
+module.exports = publicMethods;
+if (typeof window !== 'undefined') {
+    window.todayDay = publicMethods;
+}

package/languages.js

@@ -1,5 +1,5 @@
-module.exports = {
-    en_US: ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'],
-    fr_FR: ['dimanche', 'Lundi', 'Mardi', 'Mercredi', 'Jeudi', 'Vendredi', 'samedi'],
-    he_IL: ['ראשון', 'שני', 'שלישי', 'רביעי', 'חמישי', 'שישי', 'שבת'],
-};
+module.exports = {
+    en_US: ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'],
+    fr_FR: ['dimanche', 'Lundi', 'Mardi', 'Mercredi', 'Jeudi', 'Vendredi', 'samedi'],
+    he_IL: ['ראשון', 'שני', 'שלישי', 'רביעי', 'חמישי', 'שישי', 'שבת'],
+};

package/package.json

@@ -1,43 +1,43 @@
-{
-  "name": "today-day",
-  "version": "1.5.0",
-  "description": "Get today day",
-  "main": "index.js",
-  "scripts": {
-    "test": "jest",
-    "test:coverage": "jest --coverage",
-    "eslint": "eslint index.js",
-    "build": "browserify index.js > dist/today-day.min.js -p tinyify",
-    "npm-publish": "npm publish --access public"
-  },
-  "homepage": "https://github.com/davidfrid02/today-day#readme",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/davidfrid02/today-day.git"
-  },
-  "keywords": [
-    "date",
-    "day",
-    "today",
-    "day-today",
-    "today-day",
-    "random-day"
-  ],
-  "author": "",
-  "license": "ISC",
-  "prettier": {
-    "trailingComma": "es5",
-    "tabWidth": 4,
-    "semi": true,
-    "singleQuote": true,
-    "printWidth": 120
-  },
-  "devDependencies": {
-    "eslint": "^7.32.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-plugin-import": "^2.24.2",
-    "husky": "^7.0.2",
-    "jest": "^27.1.1",
-    "tinyify": "^3.0.0"
-  }
-}
+{
+  "name": "today-day",
+  "version": "1.5.2",
+  "description": "Get today day",
+  "main": "index.js",
+  "scripts": {
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "eslint": "eslint index.js",
+    "build": "browserify index.js > dist/today-day.min.js -p tinyify",
+    "npm-publish": "npm publish --access public"
+  },
+  "homepage": "https://github.com/davidfrid02/today-day#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/davidfrid02/today-day.git"
+  },
+  "keywords": [
+    "date",
+    "day",
+    "today",
+    "day-today",
+    "today-day",
+    "random-day"
+  ],
+  "author": "",
+  "license": "ISC",
+  "prettier": {
+    "trailingComma": "es5",
+    "tabWidth": 4,
+    "semi": true,
+    "singleQuote": true,
+    "printWidth": 120
+  },
+  "devDependencies": {
+    "eslint": "^7.32.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-plugin-import": "^2.24.2",
+    "husky": "^7.0.2",
+    "jest": "^27.1.1",
+    "tinyify": "^3.0.0"
+  }
+}