country-live-clocks - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

index.js

@@ -324,14 +324,13 @@ /**
 function getCountryLiveClock(countryCode) {
-    const timezonesForCountry = getTimezonesForCountry(countryCode);
-    const timezones = timezonesForCountry.map(timezone => timezone.name);
-    return timezones.slice(0, 5).map(timezone => {
-        const time = new Date().toLocaleTimeString('en-' + countryCode, {
-            timeZone: timezone,
-            hour12: true,
-            timeStyle: 'short'
-        });
-        return { timezone, time };
-    });
+    if (!countryCode) throw new Error("Country Code is required");
+    
+    const timezonesForCountry = getTimezonesForCountry(countryCode.toUpperCase());
+    if (!timezonesForCountry?.length) throw new Error("Invalid Country Code");
+    
+    return timezonesForCountry.slice(0, 5).map(({ name: timezone }) => ({
+        timezone,
+        time: new Date().toLocaleTimeString('en-US', { timeZone: timezone, hour12: true, timeStyle: 'short' })
+    }));
 }
 
 module.exports = getCountryLiveClock;

package.json

 {
   "name": "country-live-clocks",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Country Live Clock is a versatile npm package designed to provide real-time timezone information for any country. By simply passing a country code, users can retrieve an array of objects detailing the current time across all the time zones within that country. Whether you're building applications that require accurate global time display, scheduling software that spans multiple time zones, or just need a quick way to check the time in different parts of a country, Country Live Clock offers a straightforward and efficient solution.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,1 +0,54 @@
-# CountryLiveClocks
+# Country Live Clocks
+
+Country Live Clock is a versatile npm package designed to provide real-time timezone information for any country. By simply passing a country code, users can retrieve an array of objects detailing the current time across all the time zones within that country. This package is ideal for applications requiring accurate global time display, scheduling software that spans multiple time zones, or anyone needing a quick way to check the time in different parts of the world.
+
+## Features
+
+- Fetch real-time timezone information by country code.
+- Supports all countries and their respective time zones.
+- Easy to integrate with any JavaScript project including frameworks like React, Vue, Angular, and backend Node.js applications.
+
+## Installation
+
+To install Country Live Clocks, run the following command in your project directory:
+
+bash
+npm install country-live-clocks
+
+
+## Usage
+
+Here's a quick example to get you started:
+
+javascript
+const { getCountryLiveClock } = require('country-live-clocks');
+// Replace 'US' with the country code you're interested in
+getCountryLiveClock('US').then(timezones => {
+console.log(timezones);
+}).catch(error => {
+console.error('Error fetching timezones:', error);
+});
+
+
+## API
+
+### `getCountryLiveClock(countryCode)`
+
+- `countryCode` - A string representing the ISO 3166-1 alpha-2 country code.
+- Returns: A promise that resolves to an array of timezone objects for the specified country.
+
+## Contributing
+
+Contributions are always welcome! Please read the [contributing guide](CONTRIBUTING.md) to learn how you can help improve Country Live Clocks.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+If you encounter any issues or have any questions, please file an issue on the [GitHub issues page](https://github.com/ankitjha-webdev/CountryLiveClocks/issues).
+
+## Acknowledgments
+
+- Thanks to all the contributors who have helped to make this project better.

No alert changes

Improved metrics

Total package byte prevSize

85003

increased by2.5%

Number of lines in readme file

55

increased by5400%

Worsened metrics

Lines of code

4164

decreased by-0.07%

No dependency changes